https://github.com/capellax02/socketio-realtime-chat-app
Simple real-time chat application built using Socket.IO for instant messaging. The backend is powered by Express, while React lies on the frontend. The focus of this project is to demonstrate real-time communication using Socket.IO, enabling users to chat seamlessly in real time.
https://github.com/capellax02/socketio-realtime-chat-app
html-css realtime-chat socket-io
Last synced: 2 months ago
JSON representation
Simple real-time chat application built using Socket.IO for instant messaging. The backend is powered by Express, while React lies on the frontend. The focus of this project is to demonstrate real-time communication using Socket.IO, enabling users to chat seamlessly in real time.
- Host: GitHub
- URL: https://github.com/capellax02/socketio-realtime-chat-app
- Owner: CAPELLAX02
- Created: 2024-08-11T15:17:46.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T11:09:03.000Z (over 1 year ago)
- Last Synced: 2025-10-10T05:32:53.696Z (9 months ago)
- Topics: html-css, realtime-chat, socket-io
- Language: JavaScript
- Homepage:
- Size: 1.73 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Socket.IO Realtime Chat App
This project is a real-time chat application built using Socket.IO and Express. The client side is developed with React and is located in the `client` directory.
## Demo Video 🎬
https://github.com/user-attachments/assets/9b58c1a1-b9e6-4351-b872-dd310befa600
## Getting Started
Follow these instructions to get the project up and running on your local machine.
### Prerequisites
Make sure you have the following installed on your machine:
- Node.js (v14.x or later)
- npm (comes with Node.js)
- Git
### Installation
1. **Clone the repository**
Clone this repository to your local machine using the following command:
```bash
git clone git@github.com:CAPELLAX02/socketio-realtime-chat-app.git
cd socketio-realtime-chat-app
```
2. **Install dependencies**
Install the dependencies for both the server and client:
```bash
npm install
```
Then navigate to the `client` directory and install the client-side dependencies:
```bash
cd client
npm install
cd ..
```
### Running the Application
There are several scripts defined in the `package.json` file to help you run the application:
- **Start the server only:**
```bash
npm run server
```
This will start the server using `nodemon`, which automatically restarts the server whenever you make changes.
- **Start the client only:**
```bash
npm run client
```
This will start the React client application.
- **Run both the server and client concurrently:**
```bash
npm run dev
```
This will start both the server and the client at the same time using `concurrently`.
## Testing the Application
- To test the application, you can open the application in different browsers or in incognito mode to simulate multiple users. You can then join the same chat room and verify that messages are sent and received in real-time between different users.
### Project Structure
- **server.js**: Main server file for the backend using Express and Socket.IO.
- **client/**: Contains the React frontend for the chat application.
### Author
Ahmet ATAR
### Issues
If you find any bugs or have any issues, please report them [here](https://github.com/CAPELLAX02/socketio-realtime-chat-app/issues).
### Additional Information
For more details on how this project works, visit the [GitHub repository](https://github.com/CAPELLAX02/socketio-realtime-chat-app).