The Red Alliance - API

NodeJS REST API for interacting with MongoDB. Backend database for TRA.

Deploying the API

• The Docker image has been published to GitHub Packages here. It exposes the HTTP interface at port 8190.

Unit Testing

• Run yarn test to run the Mocha/Chai tests.

Documenation

REST API Documentation

The REST API documention can be found here. It conforms to the Swagger OpenAPI v2 model and seperates both authenticated and public routes.

Database handlers and internal documentation

Documentation for internal APIs can be found here.

DB Handler docs are currently not rendered, please check in src/db-handlers/ for the TypeDoc annotations.

Status Badges