README.md

Chatroomies

A web-based chat system

Featuring:

• Stock quote bot in the chatrooms (just type /command=argument in the chat)
• Multiple chatrooms

Table of Contents:

• Installation
• Project Architecture
• Contributing
• Team
• FAQ
• Support
• License

---

Installation:

Requisites:

• Install docker and docker-compose

Clone:

• Clone this repository:
  • git clone [email protected]:claudinoac/chatroomies

Setup:

• Run make init

• Wait until all the container are up and running

• Access http://localhost:8080

• Log-in into the platform using default credentials or create another one on /login/signup endpoint

  • Default credentials - user:admin - password: admin

• Choose or create a new chat in the /chatroom endpoint (will be automatically redirected to after login or signup)

• Start chatting !

---

Architecture Overview (C4 Model):

The architecture model was created using Structurizr DSL and PlantUML

There are 5 containers in the whole project

• percona -> MySQL database
• rabbitmq -> RabbitMQ broker
• chatroomies_web -> Django Web application Server
• chatroomies_bot -> Chatroomies Bot Server
• chatroomies_bot_receiver -> Chatroomies Bot Result Receiver

Testing:

Unit tests:

• The unit tests are based on Django test suite and PyTest

• All the unit tests will be in the tests/unit path, inside each application.

• To run the unit tests, run

  • $ make test unit

---

Contributing

To get started...

Step 1

• Option 1

  • 🍴 Fork this repo!

• Option 2

  • 👯 Clone this repo to your local machine using https://github.com/claudinoac/chatroomies.git

Step 2

• HACK AWAY! 🔨🔨🔨

Step 3

• 🔃 Create a new pull request using https://github.com/claudinoac/chatrommies/compare/.

---

Team

Maintainers:

Alisson Claudino
github.com/claudinoac

Contributors:

---

FAQ

• How can I can do ...?
  • Response will be here

---

Support

Reach out to me at one of the following places!

• Twitter at @_claudinoac

---

License

• GNU GPLv3