This is a backend implementation for a real-time chat application using Node.js, Express, Socket.io, MongoDB, and Prisma. It allows users to register, login, create rooms, join existing rooms, and chat in real-time with other users in the same room.
- Prerequisites
- Installation
- Configuration
- Database Setup
- Usage
- Structure
- Dependencies
- Contribution
- License
- Node.js installed (v14.0.0 or higher)
- MongoDB installed and running
- Prisma CLI installed globally (
npm install -g prisma)
- Clone this repository.
- Navigate to the project directory.
- Install dependencies using
npm install.
- Create a
.envfile based on.env.example. - Set up your MongoDB connection URI in the
.envfile. - Configure other environment variables as needed.
- Run
prisma migrate devto apply migrations and create the database schema. - Seed the database with initial data (optional).
- Start the server using
npm start. - Access the API endpoints using your preferred API client (e.g., Postman).
POST /user/register: Register a new user.POST /user/login: Log in with registered credentials.POST /room/new: Create a new chat room.GET /room/:roomid: Join an existing chat room.DELETE /room/:roomId: Delete an existin roomGET /room/users/:roomId: Get online members in a room.GET /room/messages/:roomId: Get message history of a room.Get /room/:username: Get list of all rooms the user has joined- Socket.io events for real-time communication (see code for implementation details).
/contains the application source code./controllers/holds route controllers.prisma/contains Prisma schema and models.routes/contains all routing logic.nuddleware/contains jwt authentication logic as well as logging functionality.
- Express.js - Web framework for Node.js.
- Socket.io - Real-time bidirectional event-based communication.
- MongoDB - Database for storing chat data.
- Prisma - ORM for database interactions.
- Other necessary dependencies (listed in
package.json).
Feel free to contribute by forking the repository, making changes, and creating a pull request. Bug fixes, improvements, and new features are welcomed.