Chatty

Project   |    Technologies   |    Services Used   |    Getting Started   |    How To Use   |    Features   |    License

💻 Project

Chatty is a real-time customer service chat.

🚀 Technologies

This project was developed using these techs:

• Node.js
• JavaScript
• Typescript
• Express
• Socket.io

👨‍🔧 Services Used

• GitHub

🎮 Getting Started

If you want run this code, you can start cloning the repository using HTTP or SSH key.

• Open your git

• Type git clone

• Insert the HTTP or SSH key (on windows, shift + insert to paste on gitBash)

• You can find this HTTP or SSH Key by clicking on Code on the top right in this repository

• Once cloned you can open the project in your IDE and enter the codes below in the IDE terminal

yarn To add the dependencies on the project.

If you don't already have the database.sqlite file inside the src/database folder, create this file and run yarn typeorm migration:run to create the database tables.

yarn start Runs the app in the development mode.
Open http://localhost:3333 to view it in the browser.

Dependencies

• Ejs
• Express
• Socket.io
• SQLite
• TypeORM with Reflect Metadata

Dev Dependencies

• Ts Node Dev
• TypeScript

📌 How to Use

1 - After running the application you can check how real-time communication takes place using socket.io

1.1 - Access http://localhost:3333/pages/client, open the Support Chat and enter a message and email address;

1.2 - Access http://localhost:3333/pages/admin and reply the "customer"!

🕵 Features

The main features of the application are:

Client

• Access a suport chat
• Send informations
• Conversation history

Admin

• See all customers who have unanswered questions
• Reply a customer
• Conversation history

📝 License

This project is under MIT license.

In case of sensitive bugs like security vulnerabilities, please contact deywerson.pereira@gmail.com directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!

---

Please follow on github and join us! Thanks for visiting me and good coding!

Made with ♥ by Deywerson Pereira