Table of Contents

• Table of Contents
• Overview
  • Main features
  • Run locally with docker
  • Screenshots
    • Private chat
    • Group chat
    • View all screenshots
• Techstack
  • Frontend
  • Backend

Overview

RealChat is a chat application build with Node.js and Typescript. It provides a real-time chat platform for users to chat with each other. RealChat supports both private and group chat conversations.

Main features

• Authentication using JWT tokens.
• Real time private chat.
• Real time group chat.
• Black theme support.

Run locally with docker

1. Clone the repo

   git clone https://github.com/ramesh-km/messaging-app.git

2. Provide the environment variables

   Backend backend/.env

   DATABASE_URL="postgresql://postgres:postgres@localhost:5432/postgres?schema=public"
   JWT_SECRET=randomsecretstring
   PORT=8080
   SENDGRID_API_KEY=sendgridapikey
   FRONTEND_URL=http://localhost:5173
   SENDGRID_FROM_EMAIL=send-from-email
   NODE_ENV=development

   Frontend frontend/.env

   VITE_APP_TITLE="Chat Application"
   VITE_API_URL=http://localhost:8080/api/v1
   VITE_SOCKET_URL=http://localhost:8080

3. Run the docker-compose file

   docker-compose up

4. Open the browser and go to http://localhost

Screenshots

Private chat

Group chat

View all screenshots

Techstack

Frontend

• Reactjs & Vite
• Mantine
• Tanstack Query and React router
• Zod
• Socket.io client

Backend

• Nodejs/Expressjs
• Socket.io
• Prisma
• jsonwebtokens, pino, zod, swagger

---