README.md

chat-service

A microservice for chat messaging.

Resources

• Diagram Class

• API Documentation

• Inspired by m3o chat api

Env. variables

• DATABASE_URL : Database connection string. More information here
• DATABASE_TYPE : disk, mysql, postgres, mongo (default to disk)

Usage

Run docker image

docker run -it -p 80:1337 -e "DATABASE_TYPE=mongo" -e "DATABASE_URL=mongodb://localhost:27017/chat_service_db" --name chat-service darkpearl/chat-service

Run using docker compose

See backend usage example in docker-compose.test.yml file.

Get started for development

Install dependencies

npm install

Define environment variables in .env file

cp .env.example .env

Start in development mode

./scripts/start-dev.sh

API will be running at http://localhost:1337

Properly stop development mode after shutting down Sails with <Ctrl> + C

./scripts/stop-dev.sh