INSTALL.md

HOW TO install Open Prices API

Prerequisites

• Python 3.11 (lower version may be OK, but untested)
• PostgreSQL 13 (lower version may be OK, but untested)

Setup

# Clone repo
git clone https://github.com/openfoodfacts/open-prices.git
cd open-prices

# Copy .env.example to .env

Without Docker

# Install poetry (Python dependency manager)
# see https://python-poetry.org/docs/

# Install dependencies (pyproject.toml)
poetry install

# Note: all future commands should be prefixed with `poetry run`

# Apply migrations
python manage.py migrate

# Run Locally
python manage.py runserver

# Now the server will run on http://127.0.0.1:8000 !

# Note: you can change the port if you want
python manage.py runserver 8001

With Docker

::: Info Open Prices now only supports docker compose v2 ( docker compose ) :::

create the dockers with

docker compose up

The sever should be running on http://127.0.0.1:8000/.

The run the migration of the database with

make migrate-db

Congrats, you can now contribute to the codebase 🎉