Skip to content

Commit

Permalink
Better README instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
lotif committed Feb 22, 2024
1 parent 87ceb10 commit 584c8d8
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ pip install --upgrade pip poetry
poetry install
```

### Install Yarn

We use [Yarn](https://yarnpkg.com/) to manage front-end dependencies. Install it on MacOS
using [Homebrew](https://brew.sh/):

Expand All @@ -33,21 +35,21 @@ Then install the project dependencies:
yarn
```

## Running the server

### Start server's Redis instance

Redis is used to facilitate the communication between FL4Health/Flower servers and
FLorist server.
### Pulling Redis' Docker

First, make sure you have Docker installed, and if you don't follow
[these instructions](https://docs.docker.com/desktop/).
Redis is used to facilitate the communication between FL4Health/Flower and
FLorist's servers and clients.

Then, pull Redis' official Docker image (currently we use version 7.2.4):
If you don't have Docker installed, follow [these instructions](https://docs.docker.com/desktop/)
to install it. Then, pull Redis' official docker image (we currently use version 7.2.4):
```shell
docker pull redis:7.2.4
```

## Running the server

### Start server's Redis instance

If it's your first time running it, create a container and run it with the command below:
```shell
docker run --name redis-florist-server -d -p 6379:6379 redis:7.2.4 redis-server --save 60 1 --loglevel warning
Expand All @@ -73,9 +75,6 @@ back-end APIs individually, they will be available at `https://localhost:8000`.

### Start client's Redis instance

Similarly to the server, FLorist's client also uses Redis to facilitate the
communication with FL4Health/Flower client.

If it's your first time running it, create a container and run it with the command below:
```shell
docker run --name redis-florist-client -d -p 6380:6379 redis:7.2.4 redis-server --save 60 1 --loglevel warning
Expand Down

0 comments on commit 584c8d8

Please sign in to comment.