Post and Follow

Post and Follow

A twitter-like REST API using TDD.

Highlights:

1. Test-driven development
2. Caching implemented
3. Message Queue implemented using BullMQ

Prerequisites

• Node.js v20
  • Need version 20 to load env file natively.
• Docker

Installation

git clone https://github.com/Aryan3212/mini-twitter.git cd mini-twitter npm install

Usage

Copy .env.example file into a new .env file:

Set env variables:

Know how to set up a separate App Password for Gmail here https://support.google.com/mail/answer/185833?hl=en

Spin up Redis Docker Container:

To start the server:

npm start

To start the worker:

# This worker is responsible for completing queued jobs in Redis npm run worker:dev

To run tests:

npm run test