Skip to content

Commit

Permalink
Merge pull request CS3219-AY2324S1#267 from anthonynmh/dev
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
anthonynmh authored Nov 15, 2023
2 parents 02c9e81 + fab7b4c commit 9f778d2
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 17 deletions.
31 changes: 19 additions & 12 deletions docs/LocalRabbitMqSetup.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
# Setup RabbitMQ Locally

## Install Erlang on Computer
For Windows OS,

- Download and install [Erlang](https://www.erlang.org/downloads) before you install the
1. Install Erlang on Computer

- Download and install [Erlang](https://www.erlang.org/downloads) before you install the
[RabbitMQ](https://www.rabbitmq.com/download.html) server
- For Windows OS, it is recommended to install the 64-bit version
- For Windows OS, it is recommended to install the 64-bit version

2. Install RabbitMQ on Computer

- Download and install [RabbitMQ](https://www.rabbitmq.com/download.html) server
- You can use the default settings given
- Port should be `5672`

## Install RabbitMQ on Computer
For Mac OS,

- Download and install [RabbitMQ](https://www.rabbitmq.com/download.html) server
- You can use the default settings given
- Port should be `5672`
1. Install [Homebrew](https://brew.sh/)
2. Install [RabbitMQ](https://www.rabbitmq.com/install-homebrew.html)

## Start RabbitMQ Service

Expand All @@ -26,12 +33,12 @@ For Windows OS,
- Blank: Need to be started, do the next step
7. Right click on the RabbitMQ Service and press `Start`

For macOS,
For Mac OS,

1. Click on the apple icon on the top left of the screen
2. Click on `System Settings` to open System Settings
3. Search for `RabbitMQ`
4. Click `Start RabbitMQ Server` if it has not been started
1. Open your terminal
2. To start service: `brew services start rabbitmq` into the terminal
3. Leave the terminal running
4. Remember to stop the service after you are done using PeerPrep: `brew services stop rabbitmq`

## Open RabbitMQ Management Browser

Expand Down
10 changes: 6 additions & 4 deletions docs/LocalRedisSetup.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,32 @@
# Setup Redis Locally

## For Windows
For Windows OS,

1. Download and install [Ubuntu](https://ubuntu.com/download/desktop)
- It is recommended to install the 64-bit version
2. Install [Redis](https://redis.io/docs/install/install-redis/install-redis-on-windows/) server
- You can follow the instructions given
- Port should be `6379`

## For Mac OS
For Mac OS,

1. Install [Homebrew](https://brew.sh/)
2. Install [Redis](https://redis.io/docs/install/install-redis/install-redis-on-mac-os/)

# Start Redis Service

## For Windows
For Windows OS,

1. Start your Ubuntu terminal
2. To start service: `redis-server` into the terminal
3. Leave the terminal running

## For Mac OS,
For Mac OS,

1. Open your terminal
2. To start service: `brew services start redis` into the terminal
3. Leave the terminal running
4. Remember to stop the service after you are done using PeerPrep: `brew services stop redis`

---

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 9f778d2

Please sign in to comment.