Skip to content

Real-time chat app built with the MERN stack and Socket.IO. Users can sign up, log in, and chat instantly. πŸŒπŸ’¬

Notifications You must be signed in to change notification settings

CurrentlyDormant/ChatApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

MERN Real-Time Chat App | Build Your Own Chat Application

ChatApp Banner

Overview

Welcome to the ChatApp repository! This project showcases a real-time chat application built with the MERN stack and https://github.com/CurrentlyDormant/ChatApp/releases Users can sign up, log in, and engage in instant messaging. This app serves as a great starting point for anyone looking to learn about real-time web applications.

Table of Contents

Features

  • User Authentication: Users can create accounts and log in securely.
  • Real-Time Messaging: Send and receive messages instantly.
  • Responsive Design: Works on both desktop and mobile devices.
  • User-Friendly Interface: Simple and clean layout using Tailwind CSS.

Tech Stack

Installation

To get started with the ChatApp, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/CurrentlyDormant/ChatApp/releases
    cd ChatApp
  2. Install Dependencies:

    For the backend, navigate to the server directory:

    cd server
    npm install

    For the frontend, navigate to the client directory:

    cd client
    npm install
  3. Set Up Environment Variables:

    Create a .env file in the server directory and add your MongoDB URI and JWT secret:

    MONGO_URI=your_mongodb_uri
    JWT_SECRET=your_jwt_secret
    
  4. Run the Application:

    Start the backend server:

    cd server
    npm start

    Start the frontend application:

    cd client
    npm start

Your application should now be running at http://localhost:3000.

Usage

To use the ChatApp, follow these steps:

  1. Register: Click on the sign-up button and fill in your details.
  2. Log In: Use your credentials to log in.
  3. Start Chatting: Join a chat room and start messaging.

For a detailed guide on features, check the Releases section.

Contributing

We welcome contributions to improve the ChatApp. If you have suggestions or want to report issues, please follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/YourFeature.
  3. Make your changes and commit: git commit -m 'Add some feature'.
  4. Push to the branch: git push origin feature/YourFeature.
  5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Credits

This project is based on a tutorial by GreatStack. Special thanks to the community for their support and contributions.

Links

For the latest releases and updates, visit the Releases section. You can also download the latest version from there and execute it locally.

Download Latest Release

Feel free to explore the code, learn, and build your own features. Happy coding!