A Django based application for creating and managing a bucketlist.
- Supports multiple users
- Built with a postgres database
- Token, Session and Basic authentication supported
- Users can create multiple bucket lists and bucketlist items
- Users can edit/delete bucket lists and items in them
- Download the repo
- cd into the project root in your favorite commandline tool
- Run
pip install -r requirements.txt
to install all dependencies - Create an environment variable
DJANGO_ENVIRONMENT
with the value 'development', 'production', or 'testing' depending on the environment - Run
python bucketlist_django/manage.py test bucketlist
to run tests, with the environment variable DJANGO_ENVIRONMENT set to 'testing' - Run
python bucketlist_django/manage.py makemigrations
and then runpython bucketlist_django/manage.py migrate
to create tables in the database - Run
python bucketlist_django/manage.py runserver
to start the server - On production run
python bucketlist_django/manage.py collectstatic
to collect static files - On production set the environment variable DJANGO_ENVIRONMENT to 'production'.
Note: Postgres User must be a superuser that can create a database or else test suites wont run
version: 1.0.0
Uses Django REST Swagger to document the API. Run the server and go to the URL api/v1/docs/
You need to be logged in to get full access to the swagger documentation
The API uses tokens to authenticate, send a post request to the url /api/v1/token/
with the parameters 'username' and 'password'
There is also a user interface you can access to use the app from the root URL
https://django-bucketlist-application.herokuapp.com/
God, Google and Me