Focusing on transparent application process and efficient events management, this is the proposed web-based Housing Portal MVP for SUTD.

• Backend
  • FastAPI (Python high performance web framework)
  • Uvicorn (Python asynchronous ASGI server)
  • mongoDB
• Frontend
  • React
  • Bootstrap
• Deployment
  • Gunicorn to spin up multiple Uvicorn workers
  • NGINX serve as reverse proxy server
  • Docker containerize everything
• Testing
  • pytest
  • selenium

• Backend development requires Linux/macOS as platform. (Uvicorn depends on uvloop which is not supported on Windows)
• Python 3.6+

# At project root `YOUR/PATH/SUTDHousingPortal`
$ ./dev_setup.sh

# At project root `YOUR/PATH/SUTDHousingPortal`
# activate python virtual environment
$ source venv/bin/activate
# run local server
$ uvicorn src.api.main:app --reload

Check API documentation after firing up local server

• Go to http://0.0.0.0/docs

0. Install docker & docker-compose.

1. Build

   docker-compose build

2. Run

   docker-compose up -d

3. Stop

   docker-compose down

# At project root `YOUR/PATH/SUTDHousingPortal`
$ pytest

Demo initialization

# config db
$ vim db_config

# Terminal Window 1: At project root `YOUR/PATH/SUTDHousingPortal`
$ source db_config
$ uvicorn src.api.main:app --reload

# Terminal Window 2: At project root `YOUR/PATH/SUTDHousingPortal`
$ source db_config
$ python src/api/data_migrations/demo_init.py

Demo accounts

Demo Admin
username: admin
password: pass1234

Demo HG
username: 1000000 ~ 1000005
password: 1000000 ~ 1000005

Demo Student
username: 1000006 ~ 1000030
password: 1000006 ~ 1000030

• Huang He - @MarkHershey
• Wang Chenyu - @JamesNolan17
• Justin Peng - @Fattyboy9898
• Ong Zhi Yi - @gzyon

• MIT License Copyright (c) 2021
• This application is developed to fulfill the course requirement of SUTD 50.003 Elements of Software Construction (2021 Spring).

• Docker base images
  • tiangolo / uvicorn-gunicorn-fastapi-docker
  • tiangolo / node-frontend