NCU Plus Backend

Introduction

NCU Plus website backend. Provide RESTFUL resource api endpoints for frontend. Everyone can directly access courses information by using this api. Course information is imported by Course Fetcher.

Development

Install dependencies:

npm ci

Set environment variables:

cp .env.example .env
cp db.env.example db.env
# Edit *.env files to fit your environment

Run test database:

docker-compose up -d --build

Database is bind to port 9487, and Adminer is bind to port 8080 by default.

Start server:

npm run start:dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

License

NCU Plus is AGPL licensed.