EzConnect

By Camille Chin Rui Bin (rui_bin_chin@u.nus.edu) and Goh Li Ting (gohliting@u.nus.edu)

Project README (Documentation for Orbital, aka CP2106)

Deployment Instructions (manual)

Remember to edit customisation, i.e. MSAL policies and domain names etc

You may need to customise the email sending script for the email provider you are using.

If unclear, reference the instructions from the files in infra, espicially the Ansible playbook

Requirements

• Docker
• Node.js
• Cloudflare account and domain (if using cloudflare tunnels)
  Alternatively, expose caddy directly

0. Set environment variables, e.g. MAILERCFW_API_KEY and CLOUDFLARED_SECRET

1. In frontend folder, run npm build

2. Back in the base folder, run sudo -E docker compose up

Local testing

Same requirements as before less the cloudflare account

cd backend
# Start database container
./setUpDB.sh
# Export env variables if needed
export APP_ENV=dev
export ...
# Start flask
flask run --debug
# Inside frontend, run
cd frontend
npm run start

Project Poster