go-chat-bot

Table of contents

• General info
• Features
• Technologies
• Prerequisites
• Setup
• Usage

---

General info

A simple browser-based chat application using Go. This application allows several users to talk in multiple chatrooms and also to get stock quotes from an API using a specific command.

---

Features

• Allow registered users to log in and talk with other users in a chatroom.
• Allow users to post messages as commands into the chatroom with the following format /stock=stock_code.
• Decoupled bot that calls an API using the stock_code as a parameter (https://stooq.com/q/l/?s=aapl.us&f=sd2t2ohlcv&h&e=csv, here aapl.us is the stock_code).
• The bot parses the received CSV file and then send a message back into the chatroom using RabbitMQ. The message is a stock quote with the following format: “APPL.US quote is $93.42 per share”. The post owner of the message is the bot.
• Chat messages ordered by their timestamps and show only the last 50 messages.
• Have more than one room.
• Unit tests for the bot.
• Messages that are not understood or any exceptions raised within the bot are handled.

---

Technologies

The project is created with or uses:

• HTML
• JS
• Go
• MySql
• RabbitMQ
• Docker

---

Prerequisites

• Docker Desktop (Download from here)
• Instance of RabbitMQ
• Instace of MySQL

Notes: If you don't have an instance of RabbitMQ the easiest way to get it, is to run it in a Docker container (that's why Docker Desktop is a prerequisite), once you have installed Docker Desktop, run the following command in Powershell or Bash:

docker pull rabbitmq

Also, if you don't have an instance of MySQL, run the following commands:

docker pull mysql/mysql-server

Setup

Follow the next steps to run this project locally:

1. Make sure you can run Go apps in your computer. For this, you'll need to have installed Go 1.16.6 or higher. (Download from here).

2. Open the project solution on your IDE of preference, look inside the chat folder for the config.ymland update the connection string if you want.

3. Open Powershell or Bash and run the next command to start the containers. It's important that you keep this Powershell or Bash window open while running the application.

docker-compose up

---

Usage

To run the application open each project, chat and bot, on individuals terminals, run go build on both of them, and then execute the resulting files or run go run *.go.

Once the application is running, you just need to register as a user and login into the app to access the chatroom.

The application will be serving on http://localhost:8080.