- This project runs on Python >= 3.6 (and Django >= 2.0)
- Requirements for local virtual environments can be found in requirement/local.txt. Install with
pip install -r requirements/local.txt
- API/Secret keys are managed as environmental variables. There a no required variables but some functionality depends on certain keys. A list variables needed for production can be found in
app.json
. - Create accessible postgres database with same name (or at location specified in the
DATABASE_URL
environmental variable) and runpython manage.py migrate
- Default settings for local runs are
config/settings/local.py
. Tests (including Travis) useconfig/settings/test.py
and production environments useconfig/settings/production.py
.
Tests are handled by django: python manage.py test
This project uses Semantic UI. See their documentation for modifications.
- PEP8 with a line length requirement of 120 instead of 80
- Best practices concerning Django as described in 'Two Scoops of Django'
- Build for deployment on Heroku
- Uploaded files are handled by Amazon S3
- Emails are managed by Sendgrid
- Redis is used for caching and concurrency
License: | MIT |
---|