Skip to content

flaam-org/flaam-api

Repository files navigation

Flaam-Api

Deployment

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

Usage

make init run

Dependencies

Full list of dependencies

Model Graph

Model Graph