hsu-fyp-backend

HSU Final Year Project (Backend)

Description

Nest framework written in TypeScript.

Quickstart

If you have Docker and docker-compose installed, you may use this command to start:

# Dev mode
$ docker-compose up

You can check the logs by running the following commands:

# API
$ docker compose logs -f api

# OTP
$ docker compose logs -f otp

If not, we have two modes for running the backend:

Local mode is used in a single node deployment, and is not designed with performance in mind. This should only be used in development preview, and the machine running this needs to have enough resource for building and handling maps.

Cluster mode is basically the same with local mode except it is meant for production deployment. This is the recommended way of running the application as it is designed to work along with some sort of load balancing.

API Endpoint

http://localhost:3000/

API Docs

http://localhost:3000/api-docs

Redis Debuf

http://localhost:3001/

Note: This is not available on Cloud Deploy

Additional Configuration

By default, env variables are not needed to be set. However, if you want to change the default configuration, you may refer to the configuration guide.