Welcome to the Chat App! This is a real-time chat application built with Node.js, Express.js, React.js, and Chat Engine API. It allows users to communicate with each other in real-time, creating chat rooms and engaging in conversations. This README file will guide you through setting up and using the project effectively.
To set up the Chat App on your local machine, follow the steps below:
- Node.js (version 12 or above) installed on your machine.
- Chat Engine API credentials (You can obtain them by signing up at Chat Engine)
- Clone the repository to your local machine using the following command:
git clone https://github.com/noxiousghost/nodejs-chat-app.git- Navigate to the project directory:
cd nodejs-chat-app- Install the required dependencies in both frontend and backend direcotry seperately by running the following command:
cd Frontend
npm installcd Backend
npm install- Modify the following files to enter you ChatEngine project ID and private key: i. Frontend/src/ChatsPage.jsx ii. Backend/index.js
Once you have completed the setup process, you can start using the Chat App by following these steps:
- Start the Backend:
npm start --host- Start the Frontend:
npm run dev -- --host-
Open your web browser and visit
http://localhost:5173to access the Chat App. -
Enter any username desired and click on continue.
-
Create or join a chat room to start chatting with other users in your local network.
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.
Before contributing, please make sure to familiarize yourself with the CONTRIBUTING.md file.
This project is licensed under the MIT License. Feel free to use and modify this project for your own purposes.