Chihui8199 / CZ3003-HUF

Software Project for Course CZ3003 by Team HUF

CZ3003-HUF

Software Project for Course CZ3003 by Team HUF

Frontend Setup

Go to frontend directory:

cd frontend

1. Install Dependencies

You will need to install Node.js, npm and yarn to manage JavaScript packages that we are going to use.

Download & Install Node.js & npm
https://nodejs.org/en/

Install Yarn

npm install -g yarn

Install node modules in package.json
Make sure you are in the frontend directory before you do this.

yarn install

2. Happy hacking!

You can run the app in the development mode by using

yarn start

Open http://localhost:3000 to view it in the browser.

To build the app for production to the build folder.

yarn build

Backend Setup

1. Install Dependencies

• Python 3.9.0
• MYSQL Workbench

2. Setting Up the Virtual Environment

1. Set up a new virtual environment

   python -m venv env

2. Activate the virtual environment

   \env\Scripts\activate.bat

3. Install required libraries

   pip install -r requirements.txt

3. Set-up MySQL Workbench

1. Create new SQL connection (Remote)

   a. Connection Name:

   remote project_huf

   b. Hostname:

   database-1.c4x9cbbouqsz.us-east-2.rds.amazonaws.com

   c. Port:

   3306

   d. Username:

   admin

   e. Password:

   projecthuf

   f. Default Schema:

   project_huf

4. Setting up Project

1. Delete all the migrations file (If there is any)

   a. Open up 'loginapi', 'gameapi', 'quizapi' folders

   b. Open up 'migrations folder inside those 3 folders

   c. Delete all the files except init.py

2. Migrate all the default Django tables to your MySQL schema.

   python manage.py makemigrations

   python manage.py migrate

5. Running The Server

1. python manage.py runserver

2. Open http://localhost:8000

6. List of API URLs

• Login:

  http://localhost:8000/hufuser

• Game:

  http://localhost:8000/hufgames

• Quiz:

  http://localhost:8000/hufquiz

• Quiz Question:

  http://localhost:8000/hufquizqn

• Quiz Option:

  http://localhost:8000/hufquizoptions

• Quiz Result:

  http://localhost:8000/hufquizoptions

• Forgot Password:

  http://localhost:8000/forgot_password to test forget password, log out of cz3003 email '[e-mail]' go to https://accounts.google.com/b/0/DisplayUnlockCaptcha log into cz3003 email '[e-mail]', password: djangoreact enable https://myaccount.google.com/u/1/lesssecureapps test forgot_password