Skip to content

Commit e1b32a4

Browse files
committed
GQL-96: Updating the README
1 parent 5db75e7 commit e1b32a4

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,20 @@ CMR-GraphQL uses a few environment variables for configuring runtime options:
4040
|MMT_ROOT_URL||URL to ping when retrieving metadata from MMT e.g. https://mmt.earthdata.nasa.gov|
4141
|DRAFT_MMT_ROOT_URL||URL to ping when retrieving draft metadata from Draft MMT e.g. https://draftmmt.earthdata.nasa.gov|
4242
|LAMBDA_TIMEOUT|30|Number of seconds to set the Lambda timeout to.|
43-
|EDL_KEY_ID, EDL_JWK, EDL_CLIENT_ID|For facilitating EDL connection -- obtain these from a dev|
43+
|EDL_KEY_ID, EDL_JWK, EDL_CLIENT_ID, EDL_PASSWORD| .bash or .zshrc file|For facilitating EDL connection -- obtain these from a dev and upload. After making changes, remember to run $ source ~/.zshrc|
4444

45-
### Serverless Framework
45+
### Local Environment Spin-Up
46+
If using cmr-graphql in conjunction with MMT, setup local CMR database with the [instructions found here](https://github.com/nasa/mmt/tree/main). Then utilize one of the following commands depending on the
47+
environment you wish to point graphql towards. You do not need quotations around any variables EXCEPT for UAT's EDL_PASSWORD.
48+
49+
|Environment|CLI|
50+
|-|-|
51+
|Local| $ CMR_ROOT_URL=http://localhost:4000 EDL_CLIENT_ID=SIT Client ID EDL_PASSWORD=SIT Password npm start|
52+
|SIT| $ EDL_CLIENT_ID=SIT Client ID EDL_PASSWORD=SIT Password npm start
53+
|UAT| $ CMR_ROOT_URL=https://cmr.uat.earthdata.nasa.gov EDL_CLIENT_ID=UAT Client Id EDL_PASSWORD='UAT Password' URS_ROOT_URL=https://uat.urs.earthdata.nasa.gov npm start
4654

55+
When using Apollo Studio, you should be able to do queries without needing a token. Mutations will require you utilize the token provided to you at the URS_ROOT_URL. Once aquired, go to Headers, select "+ New header". Header Key = Authorization and value = Bearer urs.token
56+
### Serverless Framework
4757
The local development environment for the static assets can be started by executing the command below in the project root directory:
4858

4959
serverless offline

0 commit comments

Comments
 (0)