IMPORTANT

This repository has been archived in favor of monorepo architecture. The current source for CU Get Reg API is now located in thinc-org/cugetreg repository.

CU Get Reg API

Backend service for CU Get Reg.

This project is powered by NestJS and GraphQL. For official documentation, see here.

Documentation

The CU Get Reg API Documentation can be found here.

Prerequisites

1. Node 14 LTS
2. Yarn
3. Docker-compose

Installation

1. Install dependencies.

$ yarn install

2. Copy and rename .env.template to .env

$ cp .env.template .env

Running MongoDB locally

Make sure port 27017 is available.

$ docker-compose up

MongoDB should be up and running on http://localhost:27017

In case of Bind for 0.0.0.0:27017 failed: port is already allocated, make sure port 27017 is available.

Running the app

# development
$ yarn start

# watch mode
$ yarn start:dev

# production mode
$ yarn start:prod

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov