frishi/threetwo
1
0
Fork 0
Code Issues 9 Pull Requests 6 Actions Packages Projects Releases 2 Wiki Activity

📝Edits to header in README

Browse Source
This commit is contained in:
Rishi Ghan
2021-08-31 13:03:30 -07:00
parent 86d029ffba
commit 8f3fda5551
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -9,7 +9,7 @@ ThreeTwo! currently is set up as:
1. The UI, this repo. 1. The UI, this repo.
2. `threetwo-import-service` [https://github.com/rishighan/threetwo-import-service] 2. `threetwo-import-service` [https://github.com/rishighan/threetwo-import-service]
3. `comicvine-service` [https://github.com/rishighan/comicvine-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. 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: 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` 2. Create an external docker network using `docker network create proxy`
3. Run `docker-compose up --build -d` 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` 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` 1. Clone this repo using `git clone https://github.com/rishighan/threetwo.git`
2. `yarn run dev` (you can ignore the warnings) 2. `yarn run dev` (you can ignore the warnings)