Skip to content

Commit b38c71d

Browse files
committed
Updated README to reflect changes to docker example folder
1 parent 33116e4 commit b38c71d

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

examples/docker/README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,15 @@ Peform the following steps in each of the _books_, _customers_, _frontend_, and
1414

1515
1. Add a `.env` file to *each* folder with the following key/value pairs:
1616

17-
- `CHRONOS_DB`: `MongoDB` or `PostgreSQL`
18-
- `CHRONOS_URI`: The URI to the desired MongoDB or PostgreSQL database to save health metrics via **Chronos**
19-
- `BOOK_URI`: A **MongoDB** URI for the bookserver microservice to use
20-
- `CUSTOMER_URI`: A **MongoDB** URI for the customerserver microservice to use
21-
- `ORDER_URI`: A **MongoDB** URI for the orderserver microservice to use
17+
- `CHRONOS_DB` = `MongoDB` or `PostgreSQL`
18+
- `CHRONOS_URI` = The URI to the desired MongoDB or PostgreSQL database to save health metrics via **Chronos**
19+
- `BOOK_URI`= A **MongoDB** URI for the bookserver microservice to use
20+
- `CUSTOMER_URI`= A **MongoDB** URI for the customerserver microservice to use
21+
- `ORDER_URI`= A **MongoDB** URI for the orderserver microservice to use
2222

2323
2. Verify that @chronosmicro/tracker is a dependency in each of the /books, /customers, /frontend, and /orders folders (see the `package.json` in each folder).
2424

25-
- If the @chronosmicro/tracker dependency is listed as a remote npm package (i.e. `"@chronosmicro/tracker": "^8.0.1"`), no further work is needed.
26-
27-
- If the @chronosmicro/tracker dependency is listed as a local npm package (i.e. `"@chronosmicro/tracker": "file:./chronos_npm_package"`), the Docker build will require that the the Chronos code is in this folder. Either copy the _chronos_npm_package_ folder in manually, or see next bullet to automate this process **if you are a Mac user**. If the folder is copied in manually for this example, we recommend deleting the copied in folder from each directory when the example is complete.
28-
29-
- **Mac users only:** `cd` into the _scripts_ folder and run the `buildDockerExample.sh` script. This will automatically copy the _chronos_npm_package_ folder into all 4 folders, and then runs the requried `docker-compose` command. If you run this script this, the example should be up and running and no further steps are needed. To delete the copied in folders if they were not automatically deleted by `buildDockerExample.sh`, run the script `cleanupDockerExample.sh`.
25+
- If the @chronosmicro/tracker dependency is listed as a remote npm package (i.e. `"@chronosmicro/tracker": "^8.0.3"`) and you've ran *npm install*, no further work is needed continue to step 3. If you have the dependency as `"@chronosmicro/tracker": "file:./chronos_npm_package"`, make sure to change the version from `"file:./chronos_npm_package"` to `"^8.0.3"` and run npm install.
3026

3127
3. With the terminal navigated to the the examples/docker folder, run the command:
3228
```

0 commit comments

Comments
 (0)