Intro

This is the source code for the Cover Tutoring system which you can find on https://tutoring.svcover.nl.

Install

As requirements you'll need:

• Python
• Virtual Environments

First, set up your virtual environment in .env. Then, install the python requirements.

virtualenv .env
source .env/bin/activate
pip install -r requirements.txt

Next, you need to setup a few django-related things

cd web

python manage.py makemigrations
python manage.py migrate
python manage.py loaddata languages.yaml
python manage.py loaddata subjects.yaml

# You'll only need this one when you're on the server:
python manage.py collectstatic --no-input

As soon as you did that, you should be ready to go! Give it a test by spinning up the development server :)

python manage.py runserver

Now you can preview the site on http://localhost:8000/

When you're done, wrap up by pressing Ctrl+C and:

deactivate

Running on your local machine

If you want to test the site on your local machine (which you should do!), you will also need the cover-api test script and a recent version of PHP (>=7). You can place the api test script in the main folder of the project, and then run:

php -S localhost:8080

Now you can log in to your local server using the login details in the coverapi tester script!

Sending mails

You can trigger the mail digest by:

python manage.py sendmaildigest

Watch out! If you do this on production you'll spam everyone who has new messages.

Testing

If you want to write unit tests make sure you make it easy for yourself and first read this tutorial:

https://docs.djangoproject.com/en/2.0/topics/testing/overview/

Deploying

If you want to update the version on the Cover server, you have to do the following things:

Login to the Cover server and go to the studcee-tutoring folder.

Now first stash the changes made on the server, since we want them to stay: git stash

Then, update the files by pulling the changes: git pull

Now reapply the changes made: git stash apply

If you made any changes to the database, these need to be applied on the server as well. For this, run the command: web/manage.py migrate in the virtual environment.

Now, you need to make sure that the new files are picked up by the server. For this, update the modified time on the web/tutoring folder with the following command: touch web/tutoring/*

Now the system should be updated on the server!

Organisation

The website is built using Django 1.11.6.

The main code can be found in tutoring/.

So far there are the following apps:

CoverAccounts

This app handles everything related to users and their cover accounts:

• model
• Authentication forms & logistics
• Profile setting

messages

This app handles everything concerning messages between users

maildigest

This app adds sendmaildigest as command and handles everything concerned with sending the weekly mail digest.

tutors

This app handles tutors, tutoring requests, tutoring subjects and languages. And everything concerned with it (models, views, controllers).