Users Service

Users service as a standalone microservice is responsible to manage users information.

Architecture

All of the handlers of this micro-service are isolated and they're not releated to each other.

API Doc

API documentation of Users service is available in Conf and docs directory.

Defination

• brand_id: this unique identifier designed to achive a level of transparency to handle requests. It'll help to primary micro-services to understand the request. As our product have a multi branding nature in itself we need to make it clear that queries destination by brand_id.

Project Structure

All the code base provided in src directory and build files will be placed in dist directory.

Like the others HTTP server application, users use a similar context which includes:

• Application
• Router
• Resources (Controllers)
• Middlewares
• Utils

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. OSX and Linux machines typically have this already installed.
• Node.js - Download & Install Node.js and the npm package manager.
• MongoDB - Download & Install MongoDB
• Docker - Getting started with Docker

Usage

Make sure you installed requirement packages by running the following command in your shell:

npm run install

In order to run and build project on your machine the following commands provided:

• npm run start: build and run project
• npm run build: build project

Also, To make sure that new changes are linted and the code base prettified some git hooks considered which before commiting will be ran.

• npm run lint: check linting rules with eslint
• npm run formatter: prettify the code base with prettier

Testing

Please make sure after making any change to run test cases to check the functionality of all the parts.

By npm run test command you're able to run test cases.