GQL-96: Updating the README #151
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #151 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 106 106
Lines 2410 2410
Branches 274 274
=========================================
Hits 2410 2410 ☔ View full report in Codecov by Sentry. |
|
|
||
| ### Serverless Framework | ||
| ### Local Environment Spin-Up | ||
| 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 |
There was a problem hiding this comment.
MMT specific help should exist in the MMT readme. Adding this information here will only add confusion for people who aren't developing MMT.
|
|
||
| |Environment|CLI| | ||
| |-|-| | ||
| |Local| $ CMR_ROOT_URL=http://localhost:4000 EDL_CLIENT_ID=SIT Client ID EDL_PASSWORD=SIT Password npm start| |
There was a problem hiding this comment.
My commands I use look very different from these. These actually wouldn't work for me without changing my environment. We already describe the environment variables needed, that should be enough for a developer to understand, and they can use their personal preference on how to save those variables.
| @@ -40,10 +40,20 @@ CMR-GraphQL uses a few environment variables for configuring runtime options: | |||
| |MMT_ROOT_URL||URL to ping when retrieving metadata from MMT e.g. https://mmt.earthdata.nasa.gov| | |||
| |DRAFT_MMT_ROOT_URL||URL to ping when retrieving draft metadata from Draft MMT e.g. https://draftmmt.earthdata.nasa.gov| | |||
| |LAMBDA_TIMEOUT|30|Number of seconds to set the Lambda timeout to.| | |||
| |EDL_KEY_ID, EDL_JWK, EDL_CLIENT_ID|For facilitating EDL connection -- obtain these from a dev| | |||
| |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| | |||
There was a problem hiding this comment.
.bash or .zshrc file is not a default value that is used, so it doesn't make sense in that column. And again, there are more than one valid ways to save environment variables, adding that you have to run $ source ~/.zshrc is not valid for all users, and we should leave it up to the dev to set variables however they want to
|
Not needed |
Overview
What is the feature?
Current README updated with information about CLI commands for SIT and UAT spin up
What is the Solution?
Added updated CLIs
What areas of the application does this impact?
Added Local Environment Spin-Up section and edited env variables table
Testing
Reproduction steps
Attachments
Checklist