Development

Local Development

Local Requirements

Docker-CE

Install Docker CE

# Verify installation is active
systemctl show --property ActiveState docker

Node

Download and install Node LTS

Yarn

Install the latest release of Yarn

Located in /socket/ you will find a .example.env file. Make a copy of this file and rename it .env in it provide the credentials and host for your database.

Commands

SUDO may be required to run such commands

# Install NPM dependencies - Using Yarn
cd socket
yarn install

# Build using docker-compose 
# This will only build the images.
docker-compose -f docker-compose.dev.yml build

# Build and start docker images
# This will build and start the docker images.
docker-compose -f docker-compose.dev.yml up --build

Routes

Web API Server Host: api.localhost

Grafana Host: localhost

PostgreSql Host: localhost:5432