[APP NAME]

[APP NAME]

• Installation
• Starting App
• Testing
• Docker

Installation

These instructions are for use without docker

• Clone the repository https://github.com/${username}/${repository}.git
• Make sure that Node.js is installed.
• Install Node.js modules with npm NPM:

npm install

Documentation

• The API documentation with Postman can be found [here](Insert Postman Documentation)

Starting App

• To run the app, copy the file .env.example to .env and substitute the settings to match your development environment.
• Start the app with npm:

npm start

• Navigate to localhost:3000. Please note 3000 is the default port used, you can change this in .env.

Testing

• Tests are written using the Mocha library.

• To run tests with npm use:

npm test

Docker

Using Docker Standalone - Compose (Recomended for local development)

• Copy the files secrets.env.example, config.env.example to secrets.env, config.env and substitute the settings to match your development environment.

docker-compose up -d

• see logs

docker-compose logs -f

• run tests

docker-compose run --rm ${docker container name} npm test

• tear down

docker-compose down

Visit App

• Navigate to Insert App Link or http://localhost:3000(docker standalone)

Tests

• There are ${n} test suites, with ${n^n} test cases. They can be found in tests/

Stack

• Backend Language + Framework: Nodejs + Express
• Database:
• Testing Framework: Mocha
• Hosting Server:
• Container Platform: Docker
• Session Management:
• Authentication/Authorization:

Extras