From 584c8d80d4bac1b8ebdf310cf34a29115a45120a Mon Sep 17 00:00:00 2001 From: Marcelo Lotif Date: Thu, 22 Feb 2024 17:12:04 -0500 Subject: [PATCH] Better README instructions. --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d6990365..ea988c75 100644 --- a/README.md +++ b/README.md @@ -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/): @@ -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 @@ -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