archref-nodejs-ms v4.0.0

Master

Develop

Introduction

Architecture Reference service.

Running on native machine

1. Install the dependencies with npm install
2. Run the docker-compose up debug option with docker-compose -f "docker-compose.environment.yml" up -d --build to up mongodb database
3. Run the application in development mode with npm run dev
4. Access https://localhost:3000 and you're ready to go!

Running on docker engine

1. Make sure your have the docker engine installed with docker info
2. Run the docker-compose up debug option with docker-compose -f "docker-compose.debug.yml" up -d --build
3. Access https://localhost:3000 and you're ready to go!

Docs

Docs (Swagger/OAS 3.0) are at http://localhost:[PORT]/api/docs

Scripts

This boilerplate comes with a collection of npm scripts to make your life easier, you'll run them with npm run <script name>:

• dev: Run the application in development mode
• start Run the application in production mode (prefer not to do that in development)
• test: Run the test suite
• test:unit: Run only the unit tests
• test:features: Run only the features tests
• test:integration: Run only the integration tests (before run npm i -g newman to install newman)
• coverage: Run only the unit tests and generate code coverage for them, the output will be on coverage folder
• lint: Lint the codebase

Tech

• Node v10.13+
• Express
• Helmet
• Awilix
• Joi
• Morgan
• Nodemon
• Mocha
• Chai
• Istanbul + NYC
• ESLint