README.md

Flaam-Api

This is the REST api for Flaam. The live version of this api is available at https://flaam-api.herokuapp.com/api/v1/.

To view the api documentation, visit https://flaam-api.herokuapp.com/swagger.

Requirements

• python 3.9+
• postgresql
• pipenv

Configuration

.envrc

required

• DATABASE_URL
• EMAIL_HOST
• EMAIL_HOST_USER
• EMAIL_HOST_PASSWORD

optional

• DEBUG
• SECRET_KEY
• SENTRY_DSN
• SENTRY_ENV

Development

Requirements

• direnv
• make

Usage

make init run

Dependencies

• Django
• Django-rest-framework
• PostgreSOL
• gunicorn
• sentry

Full list of dependencies

Model Graph