https://github.com/jayakrishnan-mk/real-time-notification-system

Real-Time-Chat-Application - built on Redis, which internally works on a Queue model for rate limiting. This system handles 500+ plus notifications per second.
https://github.com/jayakrishnan-mk/real-time-notification-system

authentication-middleware bullmq clean-architecture docker hashmap heartbeat microservice prisma pubsub queue-workers rate-limiting receipts reconnection redis retry-strategies rooms swagger websocket

Last synced: 11 months ago
JSON representation

Real-Time-Chat-Application - built on Redis, which internally works on a Queue model for rate limiting. This system handles 500+ plus notifications per second.

• Host: GitHub
• URL: https://github.com/jayakrishnan-mk/real-time-notification-system
• Owner: Jayakrishnan-mk
• License: mit
• Created: 2025-04-01T15:01:56.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-07-22T07:05:30.000Z (11 months ago)
• Last Synced: 2025-07-22T08:48:39.370Z (11 months ago)
• Topics: authentication-middleware, bullmq, clean-architecture, docker, hashmap, heartbeat, microservice, prisma, pubsub, queue-workers, rate-limiting, receipts, reconnection, redis, retry-strategies, rooms, swagger, websocket
• Language: TypeScript
• Homepage:
• Size: 8.41 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# 🔔 Real-Time Notification System.

A production-ready backend system to send real-time push notifications using **Node.js**, **Socket.IO**, **Redis**, **BullMQ**, and **PostgreSQL**. It supports JWT-based authentication, device-wise refresh token management, and secure token rotation.

---

## 📦 Tech Stack-

- **Node.js** (Express)

- **TypeScript**

- **Socket.IO** for real-time communication

- **Redis** for Pub/Sub

- **BullMQ** for job queues

- **MySQL** with Prisma ORM

- **Swagger** for API docs

- **JWT** with Refresh Token Rotation

- **Docker** for containerization

---

## 🧠 Features

- ✅ Real-time notification delivery using WebSocket

- ✅ BullMQ + Redis for background job processing

- ✅ Refresh token rotation with device session tracking

- ✅ Secure and scalable architecture

- ✅ Swagger UI for API testing

- ✅ PostgreSQL-based DB design

- ✅ Admin queue dashboard with authentication

- ✅ Socket room-based architecture for user isolation

---

## 📂 Project structure

- dist

- node_modules

- prisma

- src

- ->      assets

- ->      config

- ->      controllers

- ->      dtos

- ->      middleware

- ->      public

- ->      queues

- ->      routes

- ->      scripts

- ->      services

- ->      types

- ->      utils

- ->      workers

- ->      ws

- ->      index.ts

- ->      loadEnv.ts

- .dockerignore

- .env

- .env.development

- .env.production

- .gitignore

- Dockerfile

- package-lock.json

- package.json

- readme.md

- tsconfig.json

---

## 🖼️ High-Level Architecture

![HLD Diagram](./src/assets/HLD-noti.png)

---

## 🖼️ HLD - 2

![HLD Diagram](./src/assets/HLD-2-notification-system.png)

---

## 🧱 Database Schema

![DB Diagram](./src/assets/db_diagram-realtime-chatApp.png)

---

## 🔐 Token Lifecycle Flow (JWT + Refresh Token)

![Token Flow](./src/assets/flowchart_diagram_illustrates_the_JSON_Web_Token.png.png)

---

## 🔌 API Documentation

Swagger UI available at:

```

https://real-time-notification-system-production.up.railway.app/api-docs/

```

![Swagger](./src/assets/openApi-SWAGGER.png)

---

## 🔐 Bull Dashboard (For analyzing message queue)

Dashboard available at:

```

https://real-time-notification-system-production.up.railway.app/admin/queues/

```

![Queue](./src/assets/bullMQ-Dashboard.png)

---

## 🚀 Local Development Setup

```bash

# 1. Clone repo

git clone https://github.com/Jayakrishnan-mk/real-time-notification-system

# 2. Install dependencies

npm install

# 3. Start Redis & Postgres via Docker (if not already running)

# 4. Setup env

cp .env.development .env

# 5. Run migrations

npx prisma migrate dev

# 6. Start dev server

npm run dev

```

---

## 🐳 Running with Docker (Production Build)

Build and run using Docker:

```bash

# 1. Build Docker image

docker build -t realtime-notify .

# 2. Run container

docker run -d -p 3000:3000 --env-file .env.production realtime-notify

Or if you're using Docker Compose:

bash

Copy

Edit

docker-compose up --build

Make sure your .env.production is properly set up with:

DATABASE_URL

REDIS_URL

JWT_SECRET

other required variables...

```

---

## 🧪 Testing the Notification Flow

```bash

# You can test real-time notifications by:

- Logging in to get access/refresh tokens

- Opening WebSocket connection with userId

- Hitting /api/notifications to simulate push

```

---

## 🌐 Deployment

Deployed on:

- Railway (Production)

---

## 🤝 Contributing

PRs and suggestions welcome! 🙌

---

## 📄 License

MIT