Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
raphodn committed Nov 9, 2023
1 parent e247d0a commit d347d7b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
10 changes: 9 additions & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
## Prerequisites

- Python 3.10 (lower version may be OK, but untested)
- pip
- Postgresql 13 (lower version may be OK, but untested)

## Setup

### Without Docker

```
# clone repo
git clone https://github.com/openfoodfacts/open-prices.git
Expand All @@ -22,6 +24,12 @@ source venv/bin/activate
# install
pip install -r requirements.txt
# create Postgresql database
psql -c "CREATE USER open_prices_team WITH PASSWORD 'password'"
psql -c "CREATE DATABASE open_prices OWNER open_prices_team"
psql -c "GRANT ALL PRIVILEGES ON DATABASE open_prices to open_prices_team"
psql -c "ALTER USER open_prices_team CREATEROLE CREATEDB"
# environment variables
# make a copy of *.env.example* and rename it to *.env*
```
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ A REST API designed to interact with the Open Food Facts _Open Prices_ database.

## Dependencies

* Python 3.12
* Python 3.10
* [FastAPI](https://fastapi.tiangolo.com/) framework
* Postgresql 13

## How to install on your local machine

Expand Down

0 comments on commit d347d7b

Please sign in to comment.