update README, include serverless-offline and instructions for use #153
Conversation
|
|
||
| The Serverless Framework supports provisioning AWS resources, but it does not support updating existing resources. In 0.4, the default Elasticsearch version has been updated from 7.9 to 7.10. Continuing to use 7.9 should not cause any problems, but it recommended that you manually upgrade to 7.10 by going to [AWS Console - Amazon OpenSearch Service](https://console.aws.amazon.com/esv3/home), choosing the Elasticsearch domain used by your stac-server deployment (e.g., stac-server-{stage}-es), choose Upgrade from the Actions menu, and then upgrade to Elasticsearch 7.10. |
There was a problem hiding this comment.
the actual update for 7.10 is going to be in another PR, but I was working on it at the same time, and put it in the README along with all of these other changes.
|
|
||
| ```sh |
There was a problem hiding this comment.
naming the file serverless.yml.example and requring users to copy it makes it less likely that a dev will accidentally commit local changes to their serverless file, and that a merge from the upstream will overwrite customer changes.
|
|
||
| | Name | Description | Default Value | | ||
| | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | ||
| | STAC_VERSION | STAC Version of this STAC API | 1.0.0 | |
There was a problem hiding this comment.
I removed STAC_API_VERSION here, since it no longer exists
| npm run build | ||
|
|
||
| # Run ESLint | ||
| npm run lint |
There was a problem hiding this comment.
this command is in a different commit, but will eventually exist in the codebase
| Then, use npm `serve` command to run serverless offline: | ||
|
|
||
| ``` | ||
| npm run serve |
There was a problem hiding this comment.
serve uses serverless-offline
| @@ -30,7 +30,7 @@ provider: | |||
| - sqs:DeleteMessage | |||
| Resource: | |||
| Fn::GetAtt: [ingestQueue, Arn] | |||
|
|
|||
| lambdaHashingVersion: 20201221 | |||
There was a problem hiding this comment.
this addition is a recommendation from the serverless deploy command
Include directions for running locally using serveless-offline, and other updates to the README.