Update documentation

openfoodfacts · Nov 10, 2023 · ce8745a · ce8745a
1 parent d8c0dfe
commit ce8745a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -3,7 +3,7 @@
 ## Prerequisites
 
 - Python 3.10 (lower version may be OK, but untested)
-- pip
+- PostgreSQL 13 (lower version may be OK, but untested)
 
 ## Setup
 
@@ -22,6 +22,12 @@ source venv/bin/activate
 # install
 pip install -r requirements.txt
 
+# create a 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*
 ```

diff --git a/README.md b/README.md
@@ -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 database
 
 ## How to install on your local machine