cz3003-eduventure

Lab Project for NTU CZ3003 - Software Systems Analysis and Design

Setting up local environment (Windows)

This is a very simplified guide on setting up local environment for Windows

Pre-requisite:

1. Installed python3
2. Installed pip

Setting up repository

1. Go to a folder where you want the repository to be in
2. Clone the repository git clone https://github.com/adriangohjw/cz3003-eduventure.git

Setting up PostgreSQL

PostgreSQL is the relational DBMS of choice in this project

1. Download and install PostgreSQL from Windows installers
2. Use the following credentials during the installation (otherwise you can update the Config file):
   1. Username = postgres and password = localhostdbpassword
3. Open the psql command-line tool by
   1. In the Windows CMD, run the command: psql -U postgres
   2. Enter password when prompted
   3. Run the command: create database "cz3003"

Reference: Set Up a PostgreSQL Database on Windows

Setup virtual environment in project

In Windows CMD, ensure you are in the folder of your repository

1. Run python –m venv venv
2. Run venv\Scripts\activate
3. Run pip install -r requirements.txt

All required packages should have been installed!

venv\Scripts\activate is also the command to enter your virtual environment whenever you want to run the application on CMD

Setup local database

In Windows CMD, ensure you are in the folder of your repository

1. Run python manage.py db init
2. Run python manage.py db migrate
3. Run python manage.py db upgrade

To run the application

python run.py

To populate the database with mock data

python db_populate\db_populate.py

• WARNING: It will wipe the entire local test DB clean, before populating it with mock data
• To populate in local actual DB, replace from run_test import create_app with from run import create_app, save the file and execute the same command

Testing the API endpoints

1. Download and install Postman
2. Import the collection (cz3003-eduventure.postman_collection.json) (Note: not the most updated version)

Running test scripts

python tests.py

Do load testing using Locust

1. In console #1, run your local server using python run_test.py
2. In console #2, start locust server using locust --host=http://localhost:5000
3. Open web browser and go to http://localhost:8089/
4. Enter number of users and hatch rate (e.g. 100, 10)
5. Start load testing by clicking Start swarming