Skip to content

Commit 187238e

Browse files
committed
[NDR-318] Update README
1 parent 617620d commit 187238e

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ The following tools are required for all options:
3131
- [Git](https://git-scm.com/)
3232
- Docker (e.g. via [Brew](https://formulae.brew.sh/formula/docker))
3333
34+
Setup an environment variable on your local system. The environment variable points to your national-document-repository-infrastructure directory on your local system.
35+
For Linux/MacOS users add the following to your ~/.zshrc or ~/.bashrc file
36+
37+
```bash
38+
export NDRI_LOCATION=<national-document-repository-infrastructure FOLDER location>
39+
```
40+
41+
For Windows users, please follow Microsoft's recommendations for creating persistent environment variables
42+
3443
### Method 1 - Dev container within VS Code (recommended)
3544

3645
> [!IMPORTANT]
@@ -70,6 +79,14 @@ lazygit
7079
- [Node@24](https://formulae.brew.sh/formula/node@24)
7180
- [[email protected]](https://formulae.brew.sh/formula/[email protected])
7281

82+
### Initial Setup of the container
83+
84+
1. Configure Github-CLI with
85+
86+
```bash
87+
gh auth login
88+
```
89+
7390
## Monitoring
7491

7592
We have configured AWS CloudWatch to provide alarm notifications whenever one of a number of metrics exceeds its normal

0 commit comments

Comments
 (0)