https://github.com/youssefezzat304/plausch
A full-stack real-time chat application built with Socket.IO, Next.js, Node.js, and MongoDB. Still under active development.
https://github.com/youssefezzat304/plausch
chat-application mongodb nextjs real-time socket-io
Last synced: 4 months ago
JSON representation
A full-stack real-time chat application built with Socket.IO, Next.js, Node.js, and MongoDB. Still under active development.
- Host: GitHub
- URL: https://github.com/youssefezzat304/plausch
- Owner: youssefezzat304
- License: mit
- Created: 2025-03-23T19:47:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-04T11:20:17.000Z (about 1 year ago)
- Last Synced: 2025-04-04T12:25:50.075Z (about 1 year ago)
- Topics: chat-application, mongodb, nextjs, real-time, socket-io
- Language: TypeScript
- Homepage:
- Size: 536 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Plausch](https://github.com/youssefezzat304/Dialog.io-realtime-chat)
A real-time chat application built with Next.js, Node.js, Express, Socket.IO, MongoDB, and TypeScript . This project is primarily developed for **educational purposes**, serving as a hands-on learning experience in building real-time web applications with modern web technologies.
## Installation & Setup
Clone the Repository
```bash
git clone https://github.com/youssefezzat304/Plausch.git
cd Plausch
```
Install Dependencies
```bash
cd packges/server
npm install
```
```bash
cd packages/client
npm install
```
##### Setup environment variables
Server
```
// .env
NODE_ENV=development
PORT=
DATABASE_CONNECTION="mongodb+srv://:@******"
NEXTAUTH_SECRET=""
```
Client
```
// .env
NEXTAUTH_SECRET="" (the same key as in the server environment variables)
NEXTAUTH_URL=""
NEXT_PUBLIC_SOCKET_URL=""
```
#### Run the app
client
```bash
cd packges/client
pnpm run dev
```
server
```bash
cd packges/server
pnpm run dev
```
## Features
### Currently Available
- 🔒 **Authentication & Authorization**
- 📬 **Real-time Messaging**
- 🖼️ **User Profile details**
- 📡 **WebSockets for Instant Updates**
- 🤝 **Add Friends**
- ✅ **Status Check** (Online/Offline)
### Upcoming
- **📂 Sending Media Files** (Images, Videos, Documents)
- 🔍 **Search** (Users, Messages, and Chats)
- 👥 **Group Chat** (Multiple Participants, Admin Controls)
- 🚫 **Block Users** (Prevent Unwanted Interactions)
- 🎤 **Voice Notes** (Send and Receive Audio Messages)
- 📹 **Video Calls** (One-on-One & Group Video Calls)
- 🧑💻 **End-to-End Encryption**
- 🌙 **Dark Mode & Custom Themes**
- 📌 **Pinned Messages & Starred Chats**
- 📨 **Scheduled & Self-Destructing Messages**
- 🔄 **Message Reactions & Edits**
- 🌍 **Multi-Language Support**
- 🤖 **AI Chatbot Integration**
## API Documentation
### User Authentication
| Method | Endpoint | Description | Authentication required |
| ------ | -------------------- | ------------------- | ----------------------- |
| `POST` | `/api/auth/register` | Register a new user | ❌ No |
| `POST` | `/api/auth/login` | Login user | ❌ No |
| `POST` | `/api/auth/logout` | Logout user | ✅ Yes |
| `GET` | `/api/auth/me` | Get current user | ✅ Yes |
### Users
| Method | Endpoint | Description | Authentication required |
| ------- | ---------------- | -------------------- | ----------------------- |
| `GET` | `/users/:userId` | Get specific user | ✅ Yes |
| `PATCH` | `/users/:userId` | Update specific user | ✅ Yes |
### Friends
| Method | Endpoint | Description | Authentication required |
| ------ | ------------------------- | ------------------------ | ----------------------- |
| `GET` | `/:userId/privateChats` | Get private chats list | ✅ Yes |
| `GET` | `/:userId/contacts` | Get contacts list | ✅ Yes |
| `GET` | `/:userId/friendRequests` | Get friend requests list | ✅ Yes |
### Messages
| Method | Endpoint | Description | Authentication required |
| ------ | -------------------------- | -------------------------------------- | ----------------------- |
| `GET` | `/message/:conversationId` | Get messages for specific conversation | ✅ Yes |
### Private chat
| Method | Endpoint | Description | Authentication required |
| ------ | ---------------------- | ------------------------- | ----------------------- |
| `GET` | `/privateChat/:chatId` | Get specific chat details | ✅ Yes |
### Real-time events
| Event name | Triggered when |
| ----------------------- | ----------------------------------- |
| `"addFriend"` | user adds a friend |
| `"friendRequest"` | user sends a friend request |
| `"acceptFriendRequest"` | user accepts a friend request |
| `"rejectFriendRequest"` | user rejects a friend request |
| `"joinConversation"` | user joins a conversation |
| `"leaveConversation"` | user leaves a conversation |
| `"sendMessage"` | user sends a message |
| `"newMessage"` | new message is received |
| `"typing"` | user is typing a message |
| `"onlineFriends"` | user's friends online status change |
## 🖼️ Screenshots
This interface incorporates design elements inspired by [Ronas IT | UI/UX Team](https://dribbble.com/shots/23280048-Web-Chat-UI).
### Landing page (Temporary)
![]()
### Login page
### Add Friend
### Copy message and Chat info
### User Profile
more screenshots coming soon...
## License
This project is licensed under the **MIT License** .