SityRoom

This project has, as the main objective, the creation of multiple chat rooms. As side features, we have:

• Sign-in/Sign-up of users
• Limitation of the quantity of the messages to be shown
• A bot that expects the command /stock and returns the close price

Pre-requisites

This project was developed on Windows, so you will need to install the packages below to run everything smooth

• Python 3.8+: https://www.python.org/downloads/
• Docker: https://docs.docker.com/docker-for-windows/install/

If you are running it on MacOS/Ubunto, please run command bellow to install the packages needed:

sudo apt-get install python3.8
sudo apt-get install docker-ce docker-ce-cli containerd.io

Instalation

After cloning the repository, create and use a new environment to keep your personal data apart

py -m venv env
.\env\Scripts\activate

Use the package manager pip to install all required packages.

pip install -r requirements.txt

Clone and configure the RabbitMQ docker image

docker pull rabbitmq:3-management
docker-compose -p sityroom up --no-start

Usage

You will need to run:

• Docker image with RabbitMQ on it, to enable Bot running

docker start sityroom_rabbitmq_1

• Service Bot

python stooq/app.py

• Chat

python app.py

Then, you can simply access http://127.0.0.1:5000/ on your browser and create your user.

If wanted, you can use our test data, we have 2 users pre-loaded:

Email	Username	Password
[email protected]	test1	passTest1
[email protected]	test2	passTest2

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Just remember to update the requirements packages if needed.

pip3 freeze > requirements.txt