Skip to content

Latest commit

 

History

History
78 lines (47 loc) · 2.99 KB

README.md

File metadata and controls

78 lines (47 loc) · 2.99 KB
Raw

ChatZen - MERN Chat Application

ChatZen is a real-time chat application built using the MERN stack (MongoDB, Express.js, React, Node.js). It offers a secure and interactive platform for users to engage in group chats and one-to-one real-time conversations. This README provides essential information on how to initialize the project and highlights its key functionalities.

Project Overview

ChatZen is designed to provide a seamless and interactive chatting experience. It includes the following key features:

  • User Authentication: Users can create accounts, sign in, and personalize their profiles. Authentication is handled securely using Firebase Authentication.

  • Group Chat: Users can join and participate in group chats on various topics or interests. Group chats offer a platform for multiple users to engage in real-time conversations.

  • One-to-One Messaging: ChatZen also allows users to initiate one-to-one conversations with other users. These private chats are secured and offer real-time messaging capabilities.

  • Real-Time Communication: The application leverages the power of socket.io for real-time messaging. Users can instantly send and receive messages, ensuring a dynamic and interactive chat experience.

  • Message History: ChatZen keeps track of chat histories, allowing users to view past conversations and reference previous messages.

Project Initialization

To get started with ChatZen, follow these steps:

  1. Clone the Repository: Begin by cloning this repository to your local machine.

    git clone (https://github.com/2001sahil/Mern_Chat_App.git)
cd my-app

  2. Install Dependencies: Ensure that you have Node.js and npm (Node Package Manager) installed on your machine. Install the required server and client dependencies.

    # Install server dependencies
cd Server
npm install

# Install client dependencies
cd ../my-app   
npm install

  3. Configure Environment Variables:

    • Create a .env file in the Server directory with the following variables:

      MONGO_URI=your_mongodb_uri
Token=your_jwt_token
PORT=port

    • Replace your_mongodb_uri with your MongoDB URI and your_jwt_token with your Jwt token and port with your port.

  4. Start the Server and Client:

    • In the Server directory, start the Node.js server:

      npm start

    • In the my-app directory, start the React client:

      npm start

  5. Open the Application:

    The application should now be running locally. Open your web browser and navigate to http://localhost:3000 to access ChatZen.

Additional Information

For more details on the project's code structure, file organization, and dependencies, please refer to the documentation and comments within the source code files.

Enjoy using ChatZen for real-time group and one-to-one messaging! If you have any questions or encounter any issues, feel free to reach out to the project contributors.