ICMS-Group-10

COMP3278 Intelligent Course Management System Project

Getting Started

Clone the project

$ git clone https://github.com/Kevindrayana/ICMS-Group-10.git

Create a Virtual Environment (MacOS)

# create venv
$ python3 -m venv icms

# start venv

$ source icms/bin/activate

Create a Virtual Environment (Windows)

# Create a new directory for the venv
$ mkdir project_directory
$ cd project_directory

# Create Virtual Environment
$ python -m virtualenv venv
# the code below is optional if the code preceding it can't be run
$ Set-ExecutionPolicy Unrestricted -Scope Process

# Start venv
$ .\venv\Scripts\activate

Install all Dependencies for the Backend:

$ pip3 install -r requirements.txt

To Train the FaceRecognition Model:

# In the face_capture.py file, specify the uid of the face you want to train:
uid = "YOUR UID HERE"

# Create a 'data' folder in the project directory:
$ mkdir data

# run the programs in sequential order, a .pickle and .yml file will be created as a result.
$ python face_capture.py
$ python train.py

Importing the Database

# login the mysql command
mysql -u root –p

# create database.
mysql> CREATE DATABASE icms;
mysql> USE icms;

# import from sql file
mysql> source make.sql

# make sure there are 11 tables
mysql> SHOW tables;

Setting Up the Backend

# create .env file in root, fill in the blanks as such:
SQL_USERNAME=*****
SQL_PASSWORD=*****
SQL_HOST=*****
SQL_PORT=*****
EMAIL_PASSWORD=*****
OPENAI_API_KEY=****

# enable ssl certificate for email
$ bash /Applications/Python*/Install\ Certificates.command

# start flask backend
$ export flask run

Setting Up the Frontend

# start next.js frontend
$ cd frontend
$ npm install
$ npm run dev

draw.io Link For ERD

https://app.diagrams.net/#G1gjgNTLW7gVZwNqp7VPQu2kE5qAabhGFR

figma

https://www.figma.com/file/h7ggPtipuZ7AbBsN7AsK4H/COMP3278-(Copy)?type=design&node-id=212%3A1811&mode=dev