na4va4/js_socketio repository overview

⁠js_socketio

⁠Table of Contents

1. General Info⁠
2. Technologies⁠
3. Installation⁠

⁠General Info

This project is a basic Socket.IO application integrated with an Express.js server. It sets up a WebSocket server and client communication to demonstrate real-time messaging between a server and a browser.

• Server Functionalities:

  • Sends a message to the client upon connection: "Hello from the Socket.IO server".
  • Listens for messages from the client and logs them to the console.
  • Handles client disconnections.

• Client Functionalities:

  • Receives and displays the server message.
  • Sends a custom message to the server via a button click.

⁠Technologies

A list of technologies used within the project:

• Node.js⁠: Version 20.0.0
• Express.js⁠: Version 4.x
• Socket.IO⁠: Version 4.x
• Swagger⁠: Version 0.0.2

⁠Installation

Follow these steps to install and run the project:

⁠Via GitHub

Ensure you have Node.js installed on your machine:

node --version  
npm --version

Copy the repository

git clone https://github.com/nava2105/js_socketio.git

Enter the directory

cd ../js_socketio

Install the dependencies

npm install  

Run the server

node app.js

Open a browser and enter to Server: http://localhost:8000⁠

Open a browser and enter to Message: http://localhost:8000/api/message⁠

Or to review the endpoints in Swagger enter to http://localhost:8000/api-docs⁠

⁠Via Docker-hub

Pull the image from Docker-hub

docker pull na4va4/js_socketio

Start a container from the image

docker run -p 8000:8000 na4va4/js_socketio

Open a browser and enter to Server: http://localhost:8000⁠

Open a browser and enter to Message: http://localhost:8000/api/message⁠

Or to review the endpoints in Swagger enter to http://localhost:8000/api-docs⁠