Chat up

Chat up.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them

Node@v12.x.x
PostgreSql@11.x

Environment variable used in application.

Variable	Description	Example
SERVER_PORT	Set this variable to run your app on this port	3002
DB_CONNECTION_STRING	This variable is used to connect with database	dialect://username:password@host:port/database_name

Installing

A step by step series that will tell you how to get a development env running

$ cd server

$ npm ci

Installing via using docker-compose

A step by step series to run application via using docker-compose command

Use the following link to setup docker-compose on different operating system click here to check docker-compose installation commands for your operating system
Run the following command to build a docker image for application

#!/bin/bash
cd ops/local
sudo chmod a+x build.sh
./build.sh

Use the following commands to check/start/stop running docker containers/images on your local machine

List all containers (only IDs)

#!/bin/bash
docker ps -aq

Stop all running containers

#!/bin/bash
docker stop $(docker ps -aq)

docker stop <container-id> --- stop single running container

Remove all containers

#!/bin/bash
docker rm $(docker ps -aq)

docker rm <container-id> --- remove single stopped container

Remove all images

#!/bin/bash
docker rmi $(docker images -q)

docker rmi <image-id> --- remove single docker image

check running docker-compose services

#!/bin/bash
docker-compose ps

check status of running particular docker-compose services

#!/bin/bash
docker-compose ps -q <service_name>

kill running docker-compose services

#!/bin/bash
docker-compose kill

DataBase Migrations

Create Database:

$ node_modules/.bin/sequelize db:create --url 'dialect://username:password@host:port/database_name'

keyword	Example	Description
dialect	postgres	Database we are using
username	root	Username for the database
password	postgres	Password for the database
host	localhost/IP	Host on which database is running
port	5432	Port for the database
database_name	sample_database	Database name for the microservice

Create Migrations:

$ node_modules/.bin/sequelize migration:create --name migration_name

Run Migrations:

$ node_modules/.bin/sequelize db:migrate --url 'dialect://username:password@host:port/database_name'

keyword	Example	Description
dialect	postgres	Database we are using
username	root	Username for the database
password	postgres	Password for the database
host	localhost/IP	Host on which database is running
port	5432	Port for the database
database_name	sample_database	Database name from which migrations will happen

Run the Server

For Development

$ npm run start:dev

For Production

$ npm run start

Run the test cases

$ npm run test

For Validating Modules

$ npm run test-nsp

For linting

$ npm run test-lint

harsh112000/chatup-server