Canvas Gamification

Contents

• 1   Main Features
  • 1.1   Supported Types of Questions
• 2   Getting Started
  • 2.1   Cloning the Project
  • 2.2   Dependencies
  • 2.3   Local Dev
    • 2.3.1   Python
    • 2.3.2   Judge0
    • 2.3.3   Run the Website
    • 2.3.4   Admin User
  • 2.4   Tests
  • 2.5   Docker
• 3   Documentation
• 4   Authors
• 5   Collaborators

1   Main Features

Canvas Gamification is a platform where course instructors can provide questions to their student in forms of practice, assignments, quizzes, or exams.

1.1   Supported Types of Questions

• Multiple Choice
• Check Box
• Java Coding
• Parsons

2   Getting Started

2.1   Cloning the Project

If you are using windown please run this command before you clone the project. It will prevent the line endings to change from LF ro CRLF.

git config --global core.autocrlf input

2.2   Dependencies

• Python 3.7

  • Required Packages is listed in requirements.txt

• Docker

  • Required to run judge0 locally or deploying the website
  • Installation

• Judge0 server

  • Provided in docker compose

• Mailing System

  • For production requires an SMTP mailing service. Provide the details in env files.
  • For local development the email will be printed in console.

• reCaptcha

  • For production, you need to obtain your reCaptcha key and provide it in env files.
  • Details
  • For local development, recaptcha will be automatically validated

2.3   Local Dev

In local development you can set the environment variables in env/gamification.dev.env. All the field are pre populated so if you just want to run the website locally don't change it.

Go to canvas_gamification/settings.py and change

DEBUG=True

2.3.1   Python

Ensure Python3 is installed, then upgrade/install pip

python3 -m pip install pip --upgrade

Optionally you set virtual environment for python install Pipenv

python3 -m pip install pipenv

Next navigate to the project directory, once in the project directory create a virtual environment with Pipenv

pipenv shell

To install all necessary dependencies

pip install -r requirements.txt

2.3.2   Judge0

To be able to execute user's code you need to have judge0 up and running. docker-compose.dev.yml is ready to run judge0. Environment variables in env/gamification.dev.env is set to use this instance of judge0.

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

2.3.3   Run the Website

Then apply the migrations

python3 manage.py migrate

Now you can run the server by

python3 manage.py runserver

To initialize sample questions you can use

python3 manage.py populate-db --all

2.3.4   Admin User

To use the website you need an admin user. Create a super use by

python3 manage.py createsuperuser

You also need to give this user a teacher access to the website.

1. Open the website (Normally at localhost:8000)
2. Login with the super user you just created
3. Go to the admin section by clicking on the admin button at the top right of the screen
4. Go to the users section and click on your user
5. Scroll down and change the role from student to teacher
6. Save the user and open the website again

2.4   Tests

python3 manage.py test

2.5   Docker

For local development, it is recommended not to use docker for the website but only for judge0 which is provided in docker-compose.dev.yml

For production, copy env/gamification.sample.env to env/gamification.env. Fill the variables in it and run the server by

sudo docker-compose up -d

The server should be up and running on port 80

3   Documentation

Documentation is located at "docs/" folder.

Generate the html file by running this code under docs/ directory

make html

4   Authors

Keyvan Khademi

• Email: keyvankhademi@gmail.com
• GitHub: keyvankhademi

5   Collaborators

Opey Adeyemi

• Email: opeyadeyemi@gmail.com
• GitHub: opeyem1a

Carson Ricca

• Email: carsonricca28@gmail.com
• GitHub: carson-ricca