An open API service indexing awesome lists of open source software.

https://github.com/briso10-dev/web-sockets

A project fully explaining and implementing web sockets in javascript
https://github.com/briso10-dev/web-sockets

client http javascript nodejs server websocket

Last synced: about 1 year ago
JSON representation

A project fully explaining and implementing web sockets in javascript

Awesome Lists containing this project

README

          

# Web Sockets Explanation and Implemntation

## 📦 Technologies Used

| Technology | Description |
|----------------|--------------------------------------------------|
| **Javascript** | Javascript as main language in its latest ES |
| **Node.js** | JavaScript runtime for server-side development |
| **Express.js** | Minimalist web framework for building APIs |
| **Docker** | Containerization for easy deployment & scalability |

---

## Installation

**Creating a docker image:**
```bash
docker build -t node_server .
```

**Running the docker container**
```bash
docker run node_server
```
#### NB : In each case "node_server" refers to the name of the building image

---

## API Documentation
The API documentation is accessible at the following address :

```sh
http://localhost:3000/api-docs
```
---

## 🤝 Contributing

We love contributions! If you'd like to contribute to this project, follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature-name`).
3. Commit your changes (`git commit -m 'Add some feature'`).
4. Push to the branch (`git push origin feature-name`).
5. Open a pull request.

Feel free to report issues or suggest features by opening an issue in this repository.

---

## 📄 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

### 🌟 Show Your Support!

If you found this project helpful, please give it a ⭐ on GitHub! It helps others discover it too.

Happy coding! 💻✨