Skip to content

Latest commit

 

History

History
105 lines (85 loc) · 2.99 KB

README.md

File metadata and controls

105 lines (85 loc) · 2.99 KB

💬 Chat-App

Welcome to the Chat-App repository! This project is a real-time chat application built with React, Node.js, and MongoDB.

Table of Contents

📖 Introduction

Chat-App is designed to provide seamless communication between users with features such as instant messaging, user authentication, chat rooms, and private messaging.

✨ Features

  • Real-time messaging
  • User authentication
  • Chat rooms
  • Private messaging

🔧 Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js
  • MongoDB

⚙️ Installation

Clone the repository to your local machine:

```bash git clone https://github.com/tal6203/Chat-App.git ```

🚀 Running the App

To run the application, open two terminal windows: one for the React server and one for the Node.js server.

React Server

  1. Open a terminal and navigate to the `FrontEnd` directory: ```bash cd FrontEnd ```
  2. Install the required dependencies: ```bash npm install ```
  3. Start the React server: ```bash npm start ```

Node.js Server

  1. Open another terminal and navigate to the `BackEnd` directory: ```bash cd BackEnd ```
  2. Install the required dependencies: ```bash npm install ```
  3. Start the Node.js server: ```bash npm start ```

🌐 Accessing the Application

Once both servers are running, open your browser and navigate to: ```plaintext http://localhost:3000 ``` You should now be able to use the chat application. If you encounter any issues, please refer to the documentation or raise an issue on the repository.

📂 Folder Structure

The repository is structured as follows:

```plaintext Chat-App/ ├── BackEnd/ # Server-side code ├── FrontEnd/ # Client-side code └── README.md # Project documentation ```

🤝 Contributing

We welcome contributions to improve the Chat-App. To contribute, follow these steps:

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

🚀 Deployment

The application is deployed and can be accessed using the following link: Chat-App

📜 License

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

Chat-app.mp4