Let's StudEEE

Welcome to the repository for Let's StudEEE.

Installation

Setting up the dev environment

Create a virtual environment where you will install all modules necessary. A quick way to do this is:

virtualenv -p python3 venv
source venv/bin/activate

Afterwards, install all required modules:

pip install -r requirements.txt

Setting up the database

The database management system used for this project is PostgreSQL. Install the system either through the installer or through a terminal. Ensure that the postgres server is running afterwards.

Create a database named letsstudeee.

> createdb letsstudeee

Access the database through the psql command.

> psql letsstudeee

Create a user named coe134 with password coe134 then grant all privileges on the database to this user.

CREATE USER coe134 WITH PASSWORD 'coe134';
GRANT ALL PRIVILEGES ON DATABASE letsstudeee TO coe134;

Initialize the database

flask db upgrade
flask init-db

Environment variables

There is a .env file for environment variables such as admin credentials. For security, I did not include it in this repository. Contact me on setting this up.

Contribution Process

Please see contributing guide.

Deployment Process

The latest release is deployed here. All commits and updates will go through here. I will manually deploy the latest commit afterwards.

Test Process

We should add several test cases to ensure code quality. However we don't have enough time to do so.