Overview

This project is part of a series of microservices that are in my repository in order to guide other developer about micro-services architecture in nodejs.

---

Requirements

The project was developed on ubuntu 18.04 and all the instructions in this guide are based on this linux distribution. Before proceeding it is needed that you have installed on your machine the following tools:

1. nodejs => apt-get install nodejs
2. npm => apt-get install npm
3. Docker
4. Docker compose

PS: It may be needed that you have to install some npm packages that are not installed as part of the project but globally:

1. enc-cmd
2. sequelize-cli
3. You can use this development-tool project to help you out with database configuration.

---

Env variables

In order to execute this project smoothly it is necessary to create a a file called .env-cmdrc with the following structure:

{
  "development": {
    "NODE_ENV": "development",
    "DATABASE_NAME": "dev",
    "DATABASE_USER_NAME": "root",
    "DATABASE_PASSWORD": "root",
    "DATABASE_DIALECT": "mysql",
    "DATABASE_LOGGING": true,
  },
  "stage": {
    "NODE_ENV": "stage",
    "DATABASE_NAME": "dev",
    "DATABASE_USER_NAME": "root",
    "DATABASE_PASSWORD": "root",
    "DATABASE_DIALECT": "mysql",
    "DATABASE_LOGGING": true,
  },
  "test": {
    "NODE_ENV": "test",
    "DATABASE_NAME": "dev",
    "DATABASE_USER_NAME": "root",
    "DATABASE_PASSWORD": "root",
    "DATABASE_DIALECT": "mysql",
    "DATABASE_LOGGING": true,
  },
  "production": {
    "NODE_ENV": "production",
    "DATABASE_NAME": "dev",
    "DATABASE_USER_NAME": "root",
    "DATABASE_PASSWORD": "root",
    "DATABASE_DIALECT": "mysql",
    "DATABASE_LOGGING": true,
  }
}

Also a file called .sequelizerc is required with the following structure:

const path = require('path');

module.exports = {
    'config': path.resolve('./app/db/config', 'config.json'),
    'models-path': path.resolve('./app', 'models'),
    'seeders-path': path.resolve('./app/db', 'seeders'),
    'migrations-path': path.resolve('./app/db', 'migrations')
};

---

Running the project in development mode

In order to run the project in development mode it is required to execute the steps below:

1. Access the project development-tool/setup;
2. Grant execution permission to setup.sh: chmod +x setup.sh;
3. Execute the script: ./setup.sh. (This will build all required docker images and launch them);
4. docker ps and you should see all docker images up and running.

After the steps above it is necessary to check which ip address which database is running and to do check that out follow the steps belo:

User profile (MYSQL)

1. As result of command docker ps copy the CONTAINER_ID;
2. Execute docker inspect <CONTAINER_ID> and you should see in the end of the output just look for the tah "Networks => IPAddress" then copy it.
3. Access the project user-management;
4. Execute npm install;
5. Edit the file config.json and past the IP address on host env variable;
6. In the root folder of project user-management execute on terminal:
   • npm run migrate:dev;
   • npm run dev

After the steps about the service should be up and running on port 3004.

---

Running tests

In order to run the tests it is required to execute the steps below:

1. Access the project development-tool/setup;
2. Grant execution permission to setup.sh: chmod +x setup.sh;
3. Execute the script: ./setup.sh. (This will build all required docker images and launch them);
4. docker ps and you should see all docker images up and running.

After the steps above it is necessary to check which ip address which database is running and to do check that out follow the steps belo:

User profile (MYSQL)

1. As result of command docker ps copy the CONTAINER_ID;
2. Execute docker inspect <CONTAINER_ID> and you should see in the end of the output just look for the tah "Networks => IPAddress" then copy it.
3. Access the project user-management;
4. Execute npm install;
5. Edit the file config.json and past the IP address on host env variable on test environment;
6. In the root folder of project user-management execute on terminal:
   • npm run migrate:test;
   • npm run test

---