Automatic Assessment Platform (AASP)

This project was developed as part of my Final Year Project in Nanyang Technological University, Singapore.

About

AASP is a web-based online assessment platform that allows educators to create and manage assessments for their students.

The platform is built with the Django Web Framework and uses Judge0 for code compilation and execution.

Installation

Local Development

1. Clone the repository, check out the branch.

   # via http
   git clone https://github.com/leejunweisg/aasp
   
   # or via ssh (you need to add your ssh publickey to your github account)
   git clone [email protected]:leejunweisg/aasp.git

2. Make a copy of the .env_dev example file and save it as .env.

   cp ./config/.env_dev ./config/.env

3. Open .env and update the SECRET_KEY and AASP_POSTGRES_PASSWORD fields.

4. With docker-compose, create and start the containers:

   docker compose -f docker-compose-dev.yml up -d

5. Open the project in your IDE, create a virtual environment and install the requirements.

   # unix/linux
   python3 -m venv venv
   source ./venv/bin/activate
   python3 -m pip install -r requirements.txt

6. Since this is the first launch, the database needs to be generated with Django, and pre-populated with an admin account.
   Refer to migration files for the default admin account credentials.

   python3 manage.py migrate

7. Run the development webserver. The site will be accessible at http://localhost:8000/

   python3 manage.py runserver

Production

Initial Deployment

1. Clone the repository, check out the branch. You may skip this step if you already have a copy of the repository (e.g. from an archive).

   # via http
   git clone https://github.com/leejunweisg/aasp
   
   # or via ssh (you need to add your ssh publickey to your github account)
   git clone [email protected]:leejunweisg/aasp.git

2. Make a copy of the .env_prod example file and save it as .env.

   cp ./config/.env_prod ./config/.env

3. Open .env and update the SECRET_KEY and AASP_POSTGRES_PASSWORD fields.

4. If the machine is offline, you will need to first load the docker images from the exported-images.tar file.

   sudo docker load -i exported-images.tar

5. With docker-compose, create and start the containers:

   sudo docker compose -f docker-compose.yml up -d

6. Once the containers have been created and started, the site will be accessible at http://<host-ip>/ (port 80)

Performing updates

Note: If changes were made to the database schema, make sure to commit the migration files as well.

1. Push your commits to remote.
2. On the server, pull the new changes and recreate containers if necessary:

   git pull
   sudo docker compose -f docker-compose.yml up -d

Initial Setup

Default superuser account

By default, only a single admin account with superuser privileges is created. The default password for this user is password123.

Creation of other accounts

Other user accounts can be created through the Django Admin Dashboard with the admin account. This dashboard can be accessed by logging in as the admin user.

To create an Educator account, create the user and add the user to the Educator group. The same applies for Lab Assistants.

For Student accounts, they are created on demand when students are enrolled into courses, so there is no need to pre-create these accounts.

Credits

Project Contributors

Contributor	Period	Links
Lee Jun Wei	Jan - Dec 2022	Report Slides Poster Video

Others

• Bootstrap 5 Template from mazer