Accounts

What is this repository for?

• Quick summary
• Version
• Learn Markdown

How do I get set up?

Running with Node

This project uses Nodejs:

• Install nodejs

Nodejs local steps:

• Install dependencies: npm install
• Set up NODE_ENV to dev: export NODE_ENV=dev
• Run the microservice using node: node server.js --port=XXXX
• Run the microservice using nodemon: nodemon server.js --port=XXXX
• Run tests: npm tests

Running with Docker

This project uses Docker and docker-compose:

• Install Docker
• Install Docker Compose

Docker Steps

• Create Docker image: docker-compose build
• Start up project: docker-compose up
• Create Docker image and start up project: docker-compose up --build
• Run tests: docker-compose run --rm app npm test

Contribution guidelines

• Create your feature-branch from branch master.
• Write tests for your feature.
• Write routes for your feature.
• Open a pull request for branch master to code review.
• Deploy on development environment using create-inteagration-release.sh (only with one or more approves on your PR).

Check here if your build succeeds on CircleCi.