A website for students and teachers of tutorings to come together and start learning with overhead converging to 0.
View the API docs at /swagger/.
The Django application requires
- optonally: a AWS S3 server for uploaded attachments (like PDFs) View the [documentation](TODO lol).
It can be set up as a container pair (django - db) or using a lightweight sqlite3.
Create the following .env file:
SECRET_KEY="django_secret_key"
PERSONAL_TEACHER_CODE="code_that_marks_new_user_as_teacher"
ALLOWED_HOSTS="where_to_deploy_website_can_be_*"
DEBUG="OPTIONAL-true_if_in_dev"
LOCAL="true_if_working_locally_with_attachments_instead_of_on_s3"If LOCAL=True: CheckMathe uses an external PostgreSQL (PG) db and Amazon AWS S3 storage.
If LOCAL=False: CheckMathe uses an internal sqlite3 and saves media in the root dir.
If True: Add the following values:
DB_NAME="name_of_postgres_db"
DB_USER="user_having_access_to_db"
DB_PASSWORD="ens_password"
DB_HOST="OPTIONAL-host_if_remote_and_or_not_db_container"
DB_PORT="OPTIONAL-port_if_not_5432"In this version, CheckMathe sets up a second PG db container.
Start Container via docker-compose up --build -d.
When shutting system for debugging, remember to reset volumes via docker-compose down -v.
(Only if in .env the value LOCAL=False is set.)
Set up an AWS S3 Bucket and remember its connection data (Tutorial).
Add the following to .env:
AWS_STORAGE_BUCKET_NAME="bucket_name_of_s3"
AWS_S3_REGION_NAME="region"
AWS_ACCESS_KEY_ID="access_key"
AWS_SECRET_ACCESS_KEY="secret_access_key"(Only if in .env the value LOCAL=True is set.)
Nothing more to do, the sqlite3 will be created automatically and media auto saved in the root dir (explicitly not recommended!).
- Create venv:
python3 -m venv venv - Activate venv:
source venv/bin/activate - Install dependencies:
pip3 install -r requirements.txt - Create an .env in the project's root folder and fill it using the exact following structure:
- Start server via
python manage.py runserver - Locally execute the tests via
python manage.py test
A collection of tutorials that I found to be quite precise:
- YT: GitHub Pipeline (Postgres)
- YT: Setting up S3 with Django
- YT: Setting up PostgreSQL with Django
- YT: Using Github Environments
- Beim Umstieg von der pg-DB als zweiten Container war wichtig, dass alle env Werte in Github als Secrets angegeben sind.