Welcome to OSSAT (API) 💻

Django GraphQL API for OSSAT.

A Final Year Master's Project, developed for King's College London.

🏠 Demo (Frontend Only)

Configuration

These instructions assume you are going to use the default setup (MySQL, SMTP), but you may edit the code to amend the middleware accordingly if desired.

Settings discussed here can all be found in core/settings.py.

1. A MySQL database called "ossat" setup on local machine with admin user: "ossat_admin".
   • Note: If you are hosting the database remotely, or want to change any of these details, change these in the DATABASES section.
2. Two environment variables configured:
   • OSSAT_DB_PASS which contains your database password.
   • OSSAT_EMAIL_ADMIN_PASS which contains your SMTP user password.
   • SECRET_KEY to secure signed data (Optional).
3. DEFAULT_FROM_EMAIL, and all settings EMAIL_<SETTING> configured as appropriate.
4. Configure ALLOWED_HOSTS and CORS_ORIGIN_WHITELIST to contain the URL and/or IP address of your frontend.

Install

python -m pip install -r requirements.txt
python manage.py makemigrations
python manage.py migrate

Usage

If running locally:

python manage.py runserver

Or deploy to a cloud environment using your provider's instructions.

Author

👤 Tom Herring

• Github: @tdherring
• LinkedIn: @tomh99

📝 License

Copyright © 2022 Tom Herring.
This project is GNU GPLv3 licensed.