Doc/readme update

[joyguptaa]

Date: 12 Feb 2024

Developer Name: Joy Gupta

---

Issue Ticket Number

NA

Description

Updated ReadME wrt to latest workflow

Documentation Updated?

• Yes
• No

[iamitprakash]

don't need to run command to enable rabbitmq management UI

[joyguptaa]

don't need to run command to enable rabbitmq management UI

It is already written in the docker-compose file. So to answer your question, no we do not need a separate command. can be handled with single docker compose command

discord-message-broker/docker-compose.yml

Lines 17 to 19 in 764603e

	ports:
	- '5672:5672' # AMQP protocol
	- '15672:15672' # Management UI (optional)

[iamitprakash]

don't need to run command to enable rabbitmq management UI

It is already written in the docker-compose file. So to answer your question, no we do not need a separate command. can be handled with single docker compose command

discord-message-broker/docker-compose.yml

Lines 17 to 19 in 764603e

	ports:
	- '5672:5672' # AMQP protocol
	- '15672:15672' # Management UI (optional)

readme is all about running locally and look data into local system so please update here as well @joyguptaa

[joyguptaa]

readme is all about running locally and look data into local system so please update here as well @joyguptaa

But its already there in the readme.

discord-message-broker/README.md

Lines 32 to 74 in 764603e

	## Running Discord Message Broker
	There are 2 ways of running Queue and Consumer,
	- either you can setup both with docker if you are not working on consumer
	- but in case if you are working on consumer and want hot reloading, go with running consumer manually
	## Way 1: Running both RabbitMQ & Consumer using Docker
	Set the following env var(s)
	```
	QUEUE_URL = "amqp://rabbitmq:5672"
	DISCORD_SERVICE_URL = "http://host.docker.internal:<PORT>"
	DISCORD_QUEUE = <ANY_NAME> #Default: "DISCORD_QUEUE"
	```
	Run the compose command:
	```sh
	docker-compose up --build
	```
	## Way 2: Running RabbitMQ with Docker & Consumer manually
	### Running only RabbitMQ with Docker
	```bash
	docker compose -f 'docker-compose.yml' up -d --build 'rabbitmq'
	```
	> [!IMPORTANT]
	> To check if the queue is running or not, visit `http://localhost:5672`
	### Running Consumer Manually
	Set the following env var(s)
	```
	QUEUE_URL = "amqp://localhost:5672"
	DISCORD_QUEUE = <ANY_NAME> #Default: "DISCORD_QUEUE"
	DISCORD_SERVICE_URL = "http://localhost:<PORT>"
	```

[iamitprakash]

readme is all about running locally and look data into local system so please update here as well @joyguptaa

But its already there in the readme.

discord-message-broker/README.md

Lines 32 to 74 in 764603e

	## Running Discord Message Broker
	There are 2 ways of running Queue and Consumer,
	- either you can setup both with docker if you are not working on consumer
	- but in case if you are working on consumer and want hot reloading, go with running consumer manually
	## Way 1: Running both RabbitMQ & Consumer using Docker
	Set the following env var(s)
	```
	QUEUE_URL = "amqp://rabbitmq:5672"
	DISCORD_SERVICE_URL = "http://host.docker.internal:<PORT>"
	DISCORD_QUEUE = <ANY_NAME> #Default: "DISCORD_QUEUE"
	```
	Run the compose command:
	```sh
	docker-compose up --build
	```
	## Way 2: Running RabbitMQ with Docker & Consumer manually
	### Running only RabbitMQ with Docker
	```bash
	docker compose -f 'docker-compose.yml' up -d --build 'rabbitmq'
	```
	> [!IMPORTANT]
	> To check if the queue is running or not, visit `http://localhost:5672`
	### Running Consumer Manually
	Set the following env var(s)
	```
	QUEUE_URL = "amqp://localhost:5672"
	DISCORD_QUEUE = <ANY_NAME> #Default: "DISCORD_QUEUE"
	DISCORD_SERVICE_URL = "http://localhost:<PORT>"
	```

where is this step Management UI, read carefully before replaying @joyguptaa

[joyguptaa]

where is this step Management UI, read carefully before replaying @joyguptaa

I hope I made the correct changes here.

Markdown Code

discord-message-broker/README.md

Lines 63 to 74 in 3fb16e9

	> [!IMPORTANT]
	> To check if the queue is running or not, visit `http://localhost:15672`
	### RabbitMQ UI
	This is how the UI will look like once you open `http://localhost:15672`
	<img width="1127" alt="Image" src="https://github.com/user-attachments/assets/81b67f52-c762-4773-b75d-26e82d558b36" />
	> [!IMPORTANT]
	> User "guest" as username and password

README Visuals