🤣 COMP3900 Group project - Xecute the Deal 🤣

Description

This is the repository for the COMP3900 project, do not commit bad code or Ian will be angry 😈😈😈. The project selected is Investment Simulator, the application name is "Xecute the Deal".

Members and Development Roles

SCRUM MASTER	FULL STACK DEVELOPER	FRONTEND DEVELOPER	BACKEND DEVELOPER	BACKEND DEVELOPER
Peiyu Tang	Ian Park	Justin Or	Song Fang	George Bai

Deployment Environment

The application will be deployed on the cse-vlab linux environment. The specified versions are

$ python = 3.7.3
$ npm = 5.8.0
$ nodejs = 10.21.0

Quick Start

To run the application quickly, follow the below steps.

Step 1: Frontend

Quickly activate the React-JS frontend, please do

$ cd web
$ npm run build
$ npm build serve

Step 2: Virtual Environment

To quickly run the FASTAPI python backend, please first create a python virtual environment via

$ cd backend
$ python3 -m venv env_name; source env_name/bin/activate;

Step3: Run Backend

Then please do

$ python3 -m pip install -U pip; python3 -m pip install -U -r requirements.txt;
$ bash start.sh initial-populate path/to/env.yaml path/to/ecksdee-firebase.json
$ bash start.sh run