Welcome to the Chat-App repository! This project is a real-time chat application built with React, Node.js, and MongoDB.
- 📖 Introduction
- ✨ Features
- 🔧 Prerequisites
- ⚙️ Installation
- 🚀 Running the App
- 🌐 Accessing the Application
- 📂 Folder Structure
- 🤝 Contributing
- 🚀 Deployment
- 📜 License
Chat-App is designed to provide seamless communication between users with features such as instant messaging, user authentication, chat rooms, and private messaging.
- Real-time messaging
- User authentication
- Chat rooms
- Private messaging
Before you begin, ensure you have the following installed:
- Node.js
- MongoDB
Clone the repository to your local machine:
```bash git clone https://github.com/tal6203/Chat-App.git ```
To run the application, open two terminal windows: one for the React server and one for the Node.js server.
- Open a terminal and navigate to the `FrontEnd` directory: ```bash cd FrontEnd ```
- Install the required dependencies: ```bash npm install ```
- Start the React server: ```bash npm start ```
- Open another terminal and navigate to the `BackEnd` directory: ```bash cd BackEnd ```
- Install the required dependencies: ```bash npm install ```
- Start the Node.js server: ```bash npm start ```
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.
The repository is structured as follows:
```plaintext Chat-App/ ├── BackEnd/ # Server-side code ├── FrontEnd/ # Client-side code └── README.md # Project documentation ```
We welcome contributions to improve the Chat-App. To contribute, follow these steps:
- Fork the repository.
- Create a new branch (`git checkout -b feature/your-feature-name`).
- Make your changes and commit them (`git commit -m 'Add new feature'`).
- Push to the branch (`git push origin feature/your-feature-name`).
- Open a pull request.
The application is deployed and can be accessed using the following link: Chat-App
This project is licensed under the MIT License. See the LICENSE file for more details.