https://github.com/z-bj/chatsocket
This is a simple chat application built using Socket.IO and Express. It allows users to connect to a server and chat with each other in real-time.
https://github.com/z-bj/chatsocket
express nodejs socket-io
Last synced: 2 months ago
JSON representation
This is a simple chat application built using Socket.IO and Express. It allows users to connect to a server and chat with each other in real-time.
- Host: GitHub
- URL: https://github.com/z-bj/chatsocket
- Owner: z-bj
- Created: 2021-10-21T08:38:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T16:24:14.000Z (over 3 years ago)
- Last Synced: 2025-08-21T11:06:16.101Z (10 months ago)
- Topics: express, nodejs, socket-io
- Language: HTML
- Homepage: https://z-bj.github.io/chatSocket
- Size: 1.33 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Socket.IO Chat App
> This is a simple chat application built using Socket.IO and Express.
It allows users to connect to a server and chat with each other in real-time.
## Features
- Real-time communication between multiple clients
- Simple and intuitive user interface
- Automatic scrolling to the bottom of the chat window
- Easy to use and modify
## How It Works
The server uses Express to serve the `index.html` file and Socket.IO to handle incoming connections and messages. When a user connects to the server, a `connection` event is fired and a callback function is called, which logs a message to the console. Similarly, when a user disconnects, a `disconnect` event is fired and a message is logged to the console. Finally, when a user sends a chat message, a `chat message` event is fired and the message is broadcast to all connected users.
## Installation
To get started, clone the repository and install the required dependencies using `npm`:
``` bash
git clone https://github.com/yourusername/socket-io-chat.git
cd socket-io-chat
npm install
```
## Usage
Client-side [link](https://z-bj.github.io/chatSocket)
Start the server using the following command:
``` bash
node server.js
```
Then, open a web browser and navigate to `http://localhost:3000` to view the chat app.
## Code Overview
The client code is located in `index.html`. It uses the Socket.IO client library to establish a connection to the server and send and receive messages.
The server code is located in `server.js`. It initializes an Express app and creates an HTTP server using the app. Socket.IO is then initialized with the HTTP server.
Here's a brief overview of what the code does:
``` javascript
const app = require("express")();
const http = require("http").Server(app);
const io = require("socket.io")(http);
// Serve the index.html file
app.get("/", function (req, res) {
res.sendFile(__dirname + "/index.html");
});
// Handle incoming connections
io.on("connection", function (socket) {
console.log("a user is connected");
// Handle disconnections
socket.on("disconnect", function () {
console.log("a user is disconnected");
});
// Handle incoming chat messages
socket.on("chat message", function (msg) {
console.log("received message : " + msg);
io.emit("chat message", msg);
});
});
// Start the server
http.listen(3000, function () {
console.log("Server running on 3000");
});
```
## License
This project is licensed under the MIT License.