This is the Django server for CarbonAltDel. It is a Django REST Framework API server that serves the data to the React frontend.
- Install Python 3.6.5
- Install pipenv
- Run
pipenv installto install dependencies - Run
pipenv shellto enter the virtual environment - Run
python manage.py migrateto migrate the database - Run
python manage.py runserverto start the server
- Djoser: Authentication and User Management for Django REST Framework (https://djoser.readthedocs.io/en/latest/)
- Django REST Framework: Web API framework for Django (https://www.django-rest-framework.org/)
- Django REST Framework Simple JWT: JSON Web Token Authentication for Django REST Framework (https://django-rest-framework-simplejwt.readthedocs.io/en/latest/)
- Django CORS Headers: Django app for handling the server headers required for Cross-Origin Resource Sharing
- Django Filter: Generic filtering backend for Django REST Framework (https://django-filter.readthedocs.io/en/stable/)
- Stripe Python: Stripe API bindings for Python (https://stripe.com/docs/api/python)
The API is documented using Swagger. To view the documentation, run the server and go to localhost:8000/swagger/.
To run the tests, run python manage.py test.
The server is deployed on Heroku. To deploy, run git push heroku master.
- Fork the repository
- Create a new branch
- Make your changes
- Commit your changes
- Push your changes to your fork
- Create a pull request
This project is not licensed for personal or commercial use.