Skip to content

Latest commit

 

History

History
120 lines (75 loc) · 2.84 KB

Readme.md

File metadata and controls

120 lines (75 loc) · 2.84 KB

ChatNet:-Real-Time Communication Chat App

project-image

ChatNet is a real-time communication chat application built using the MERN (MongoDB Express React Node.js) stack and Socket.IO for instant bidirectional communication. This app provides a seamless and responsive chat experience supporting multiple users and rooms ensuring real-time message delivery.

🧐 Features

Here're some of the project's best features:

  • Real-time Messaging: Instant messaging with real-time updates using Socket.IO.
  • User Authentication: Secure user authentication with JWT (JSON Web Tokens).
  • Responsive Design: User-friendly interface designed for both desktop and mobile devices.
  • User Presence: Real-time user presence indicators.
  • Message History: Persistent message storage in MongoDB.
  • State Management: Efficient state management using Zustand.

🛠️ Installation Steps:

1. Clone the repository:

git clone https://github.com/GeeekySouro003/ChatNet.git

2. Go the folder


cd ChatNet

3. Install server dependencies:

cd backend 
npm install

4. Install client dependencies:

cd frontend 
npm install

🛠️ Installation Steps:

1. Server Configuration:

Create a .env file in the server directory and add the following variables:
PORT=5000 
MONGO_URI=your_mongodb_connection_string 
JWT_SECRET=your_jwt_secret_key



<p>2. Client Configuration:</p>

Create a .env file in the client directory and add the following variables: REACT_APP_API_URL=http://localhost:5000

🛠️ Running Application:

1. Start the server:

cd backend npm start

2. Start the client:

Open a new terminal window and run:

cd frontend npm start

🛠️ Usage:

1.Register and Login:

Open the application in your browser. Register a new account or login with existing credentials. 2.reate and Join Rooms:

After logging in, you can create a new chat room or join an existing one. 3.Start Chatting: Enter a room to start sending and receiving messages in real time.

💻 Built with

Technologies used in the project:

  • Reactjs
  • Mongodb
  • Nodejs
  • ExpressJs
  • Socket-io
  • Zustand

🍰 Contribution Guidelines:

Contributions are welcome! Please follow these steps to contribute:

  1. Fork the project repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature-branch).
  6. Open a Pull Request.

Happy chatting with ChatNet! 🚀