Skip to content

Commit e618123

Browse files
CMSNAV-798: Update Quick Start docs
1 parent b95de1c commit e618123

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,17 @@ The contents of this repository are protected by Crown Copyright (C).
2828
* poetry
2929
* Java 8+
3030

31+
Consider using a **dev container**. While this is in no way a requirement, you may find it more convenient.
32+
33+
### Get Environmental Variables
34+
35+
1. Make a new `.env` file in this directory, using `example.env` as a base.
36+
1. Fill in the missing environmental variables:
37+
- At the time of writing, `PROXY_NAME` should be set to `nhs-website-content-api-internal-dev`.
38+
- You can get an `APIGEE_ACCESS_TOKEN` via the `get_token` command. If you don't already have access to the `get_token` command, you can install it using [these instructions](https://docs.apigee.com/api-platform/system-administration/auth-tools#install).
39+
- You can get the latest `SOURCE_COMMIT_ID` via the `/_ping` endpoint of the proxy you're using. For example, with `PROXY_NAME` set to `nhs-website-content-api-internal-dev`, we would want to access the URL https://internal-dev.api.service.nhs.uk/nhs-website-content/_ping - this should return some JSON, and the value we want has key `commitId`.
40+
3141
### Let's Roll
3242

3343
1. Install by running `make install` from this directory.
34-
1. Test this installation by running `make smoketest`, also from this directory.
44+
1. Test this installation by running `make test`, also from this directory.

0 commit comments

Comments
 (0)