Explo Project

Steps to setup :

1. Fork the repository, and clone the forked repository.

2. Install the dependancies using following commands :

Windows

Step 1 : Install Python from the Microsoft Store

python

Step 2 : Run the following commands in the "explo" directory

python -m venv env
Set-ExecutionPolicy -Scope Process Bypass
.\env\Scripts\Activate
pip install -r requirements.txt

Step 3 : Download and Install NodeJs from https://nodejs.org/ . After Installing run these commands to run the frontend from the "explo" directory

cd frontend
npm install
npm run dev

Step 4 : Open another terminal window in the explo project directory and run these commands to run the backend from the "explo" directory

Note : Enter superuser details to create the superuser.

Set-ExecutionPolicy -Scope Process Bypass
.\env\Scripts\Activate
cd backend
python .\manage.py makemigrations
python .\manage.py migrate
python .\manage.py createsuperuser
python .\manage.py runserver

Ubuntu

Running Frontend from the "explo" directory

sudo apt-get install python3-pip
sudo pip3 install virtualenv
virtualenv env
source env/bin/activate
pip install -r requirements.txt
sudo apt install nodejs npm
cd frontend
npm install
npm run dev

Running Backend from the "explo" directory

Note : Enter superuser details to create the superuser.

source env/bin/activate
cd backend
python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py createsuperuser
python3 manage.py runserver

Mac

Running Frontend from the "explo" directory

sudo pip3 install virtualenv
virtualenv env
source env/bin/activate
pip3 install -r requirements.txt
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install node
cd frontend
npm install
npm run dev

Running Backend from the "explo" directory

Note : Enter superuser details to create the superuser.

source env/bin/activate
cd backend
python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py createsuperuser
python3 manage.py runserver

Assign Superuser Role to Users

After running the backend and frontend, go to 127.0.0.1:8000/admin and login with the created super user credentials, and then assign super user status to the user to which you want to assign the super user role

This is necessary as, to access the Teacher page of the frontend, you need to be a superuser i.e to create, delete and add quizzes.

Here's how to do it

Step 1: Login with admin credentials

Step 2: Go to Users table

Step 3: Select any user

Step 4: Tick Superuser status

Step 5: Scroll to the bottom and save the changes

Step 6: Logout and you're good to gooooo!!