Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.53 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.53 KB

Explorer Backend

The backend part of the explorer project which can be found here.

Tests Publish Docker image

A REST API for the explorer backend.

You can find an UML for the database scheme here.

Getting started

Before you get started clone this repository and the authentication repository and make sure, both repositories are located in the same folder.

You can either run the application within a docker container or directly.

Development

If you want to run the application locally, please follow the mongoDB installation guide.

Please make sure mongoDB and Explorer authentication is up and running.

Then run the following commands:

npm install
npm run start

Testing

After developing and before committing, please make sure all test are passing. MongoDB and Aura Authentication need to be up and running.

npm run test