Backend API written in Flask.
You need the following to run the app locally.
- Python 3.9
- Pipenv
- Docker
- docker-compose
Once you got it installed, you can setup a development environment locally.
pipenv install --dev
Configure any environment variables required for local development in .env
file (use config.py
as reference).
vim .env
You can then enter the virtual environment of the project.
pipenv shell
Use docker-compose
to get a development PostgreSQL database running on your system.
docker-compose up -d
Finally, you can now run the app.
flask run
On some systems, you might need to install the libpq-dev
/libpq-devel
package before installing wth Pipenv. This is because pg-config is required in order to build the psycopg2
Python package.