From a93d54f31bffbb02753525f5c962df7f75ce0a86 Mon Sep 17 00:00:00 2001 From: canove Date: Tue, 11 Aug 2020 11:40:56 -0300 Subject: [PATCH] create project README file --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..482adf6 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# WhaTicket + +A _very simple_ Ticket System based on WhatsApp messages. + +Backend uses [whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js) to receive and send WhatsApp messages, create tickets from them and store all in a MySQL database. + +The frontend is a full-featured _chat app_ bootstrapped with react-create-app and Material UI, that comunicates with backend using REST API and Websockets. + +# Motivation + +I'm a SysAdmin, and in my daily work, I do a lot of support through WhatsApp. Since WhatsApp Web don't allow multiple users, and 90% of our tickets cames from this channel, we created this to avoid the: 'Can I use Whatsapp now?' tap shoulder. + +## Installation + +todo + +## Features + +Have multiple users chating in same WhatsApp Number ✅ +Create and chat with new contacts without touching cellphone ✅ +Send and receive message ✅ +Send media (images/audio/documents) ✅ +Receive media (images/audio/video/documents) ✅ + +## Links + +- [whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js) + +## Contributing + +Any help and suggestions are welcome! + +## Disclaimer + +I just started leaning Javascript a few months ago and this is my first project. It may have security issues and many bugs. I recommend using it only on local network. + +This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates. The official WhatsApp website can be found at https://whatsapp.com. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.