From 8f3fda5551deedd228fc64d4fbf95102ee60aea2 Mon Sep 17 00:00:00 2001 From: Rishi Ghan Date: Tue, 31 Aug 2021 13:03:30 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9DEdits=20to=20header=20in=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 29e83eb..0befd3c 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ ThreeTwo! currently is set up as: 1. The UI, this repo. 2. `threetwo-import-service` [https://github.com/rishighan/threetwo-import-service] 3. `comicvine-service` [https://github.com/rishighan/comicvine-service] -## Local Development +## Docker Instructions The recommended approach is to simply use `docker-compose` which spins up containers for the UI and all the associated microservices and data store. To do that: @@ -19,8 +19,10 @@ Make sure that you have `docker` and `docker-compose` installed. 2. Create an external docker network using `docker network create proxy` 3. Run `docker-compose up --build -d` 4. Note that the first time, the process could take up to 10 minutes, since it is building containers for `threetwo`, `threetwo-import-service`, `comicvine-service`, `mongo`, `nats`, `nginx` - -However, for debugging and troubleshooting, you can run this app locally using these steps: + +## Local Development + +For debugging and troubleshooting, you can run this app locally using these steps: 1. Clone this repo using `git clone https://github.com/rishighan/threetwo.git` 2. `yarn run dev` (you can ignore the warnings)