https://github.com/thenewcivilian/simple-websocket-chat
A very simple websocket demo application for customer service.
https://github.com/thenewcivilian/simple-websocket-chat
customer-service websocket websocket-chat websocket-client websocket-server
Last synced: 3 months ago
JSON representation
A very simple websocket demo application for customer service.
- Host: GitHub
- URL: https://github.com/thenewcivilian/simple-websocket-chat
- Owner: TheNewCivilian
- Created: 2020-05-09T18:43:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T12:19:22.000Z (over 2 years ago)
- Last Synced: 2025-06-07T03:41:47.897Z (4 months ago)
- Topics: customer-service, websocket, websocket-chat, websocket-client, websocket-server
- Language: JavaScript
- Homepage:
- Size: 4.27 MB
- Stars: 6
- Watchers: 0
- Forks: 2
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
SIMPLE WEBSOCKET CHAT
A very simple javascript websocket based chat system to support customer support agents to fast react on customer requests.
View Client Demo
·
View Admin Demo
·
Report Bug
·
Request Feature
## Table of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
## About The Project
The idea of Simple Websocket Chat is too give developers a fast and simple starting point for a customer support chat implementation.
It aims to give insides into a very simple websocket implementation.
[![A chat window of a client][product-screenshot1]]()
A chat window of a client
[![A chat window of an admin][product-screenshot2]]()
A chat window of an admin
### Built With
* [Vue.js](https://vuejs.org/)
* [Node.js](https://nodejs.org/en/)
* [Webpack](https://webpack.js.org/)
## Getting Started
To get a local copy up and running follow these simple steps.
### Installation
1. Clone the repo
```sh
git clone https://github.com/TheNewCivilian/simple-websocket-chat
```
2. Test run client by running
```sh
./startServer.sh
```
```sh
./startClient.sh
```
3. Run Build Script
```sh
./build.sh
```
4. Serve Build via Webserver
You will find a bundled nodejs app in `/backend/build`. This represents the server. It can be run with node bundle.js and served via a reverse proxy.
In `frontend/simplechat/dist` you will find static web content which represents the client. This needs to be served by a standard webserver.
## Roadmap
See the [open issues](https://github.com/TheNewCivilian/simple-websocket-chat/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact & Contributors
Project Link: [https://github.com/TheNewCivilian/simple-websocket-chat](https://github.com/TheNewCivilian/simple-websocket-chat)
[contributors-shield]: https://img.shields.io/github/contributors/TheNewCivilian/simple-websocket-chat.svg?style=flat-square
[contributors-url]: https://github.com/TheNewCivilian/simple-websocket-chat/contributors
[forks-shield]: https://img.shields.io/github/forks/TheNewCivilian/simple-websocket-chat.svg?style=flat-square
[forks-url]: https://github.com/TheNewCivilian/simple-websocket-chat/network/members
[stars-shield]: https://img.shields.io/github/stars/TheNewCivilian/simple-websocket-chat.svg?style=flat-square
[stars-url]: https://github.com/TheNewCivilian/simple-websocket-chat/stargazers
[issues-shield]: https://img.shields.io/github/issues/TheNewCivilian/simple-websocket-chat.svg?style=flat-square
[issues-url]: https://github.com/TheNewCivilian/simple-websocket-chat/issues
[product-screenshot1]: img/Screenshot1.png
[product-screenshot2]: img/Screenshot2.png