mac-lisowski / colkie-task

Dockerized small service exposing API and Swagger documentation. Written in NodeJS + NestJS + MySQL

Colkie Backend Code Challenge

stack: nodejs, nestjs, mysql

Requirements

• Docker

Installation

1. Clone repository on your local computer
2. Run docker-compose up in project root

Once everything is up, API should be available under http://localhost:3000/.

Endpoints

Below you can find list of endpoints:

• Create a room
  POST /rooms
• Add a user to a room
  POST /rooms/:roomID/users
• Send a message to a room
  POST /rooms/:roomID/messages
• Get latest messages from a room
  GET /rooms/:roomID/messages

More information about API endpoints can be found under http://localhost:3000/_docs once the service is running.