README.md

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
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• 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

A chat window of an admin

Built With

• Vue.js
• Node.js
• Webpack

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

git clone https://github.com/TheNewCivilian/simple-websocket-chat

2. Test run client by running

./startServer.sh

./startClient.sh

3. Run Build Script

./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 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