Welcome to the Chat Application project! This is a web-based chat application that utilizes WebSockets to enable real-time communication between users. Below you'll find all the information you need to get started with the project.
- Real-time messaging
- User authentication
- Private and group chats
- Typing indicators
- Message notifications
- Multiple Chat Rooms
- HTML5
- CSS3
- JavaScript (ES6)
- Node.js
- WebSocket (ws library)
Ensure you have the following installed on your machine:
- Node.js (version 14 or higher)
- npm (version 6 or higher)
-
Clone the repository:
git clone https://github.com/yourusername/chat-application.git cd chat-application -
Install dependencies:
npm install
-
Set up environment variables: Create a
.envfile in the root directory and add the following:PORT=3500
-
Start the server:
npm start
-
Open the application: Navigate to
http://localhost:3500in your web browser.
-
Open the Application: Navigate to
http://localhost:3500in your web browser. -
Start Chatting:
- Enter a chat room name to create or join a room.
- Send messages in real-time and see messages from other users instantly.
-
Additional Features:
- View typing indicators when other users are typing.
- Receive notifications for new messages.
chat-application/
├── public/ # Static assets
│ ├── index.html # Main HTML file
│ └── styles.css # CSS file
├── server/ # Backend code (Node.js, WebSocket)
│ ├── index.js # Entry point for the server
├── .gitignore # Git ignore file
└── README.md # Readme file
We welcome contributions to the Chat Application project! To contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name. - Make your changes and commit them:
git commit -m 'Add some feature'. - Push to the branch:
git push origin feature/your-feature-name. - Submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for more details.