Threads API

Description

This is the backend API for berkmancenter/threads_client.

Installation

Using Docker

• Create file .env.local and copy contents of .env.example. Feel free to change the port number in the file but make sure to make changes on fronend env file to reflect the correct port number. Also, if you change the port number, make sure to change the port numbers in docker-compose.yml as well. The port number for socket io is defined implicitly in the app as 5555 and can be changed by making change to file /src/websockets/index.js
• Edit docker-compose.dev.yml file to add the following block to the node-app service

    env_file:
      - .env.local

the full block should then look like this:

services:
  node-app:
    env_file:
      - .env.local

• Run below docker compose command to start the server

docker-compose -f docker-compose.yml -f docker-compose.dev.yml up --build

Running locally

1. Start by copying .env.example to .env.
2. Install mongodb
3. Run MongoDB with mongod
4. Install all dependencies with npm install.
5. Run npm run dev to serve the API locally.

Tests

Unit and integration tests

Unit and integration tests can be run with npm run test, and a coverage report can be seen with npm run coverage.

Stress tests

Stress tests can be run from the client repo in the k6 directory.

Deployment

1. Pull the latest code from Github (currently the dev branch)
2. Configure .env and install dependencies
3. Run npm run start to serve the API with PM2