Skip to content

Commit 6dcf631

Browse files
committed
Updated readme with a few more final edits and links
1 parent 1f76180 commit 6dcf631

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ https://www.serverless.com/blog/cicd-for-serverless-part-2/
55

66
Getting started with Lambda isn't hard at all. But if you are shooting for a super simple API you are still left with a lot of boilerplate things and missing pieces to make it really useful. Each which have their own small gotchas. Testing, deployments, API Gateway, cors, staged deployments, database setup, roles, permissions, javascript modules, dependency install, etc. It can still be a decent amount of work to get to something straightforward: A datasource accessible through lambda driven by a restful API written with Javascript with no hoops for pulling in additional js dependencies. Serverless helps you get there without worrying about all that boilerplate.
77

8-
Prerequisites:
8+
## Do this first (prerequisites):
99
- [Follow Serverless setup guide](https://www.serverless.com/framework/docs/providers/aws/guide/installation/) for 3 things:
1010
1. Install Node
1111
1. Install Serverless
1212
1. Setup AWS - mostly setting up credentials
1313

14-
What I did to get started with a restful service based on a lambda backed by dynamodb.
14+
## Getting Started
1515
1. Fork the project.
1616
1. Look through the project:
1717
- **Understand what is being created in AWS**
@@ -27,5 +27,5 @@ What I did to get started with a restful service based on a lambda backed by dyn
2727
- We use local data file to mock the data we would be getting from an http call...things like the path, the path parameters, query parameters, thing like that. Look at `test/shaefer/get-local.json` This file simulates the call `https://xxxxxxxxxx.execute-api.{region}.amazonaws.com/{stage}/shaefer/{id}` for example `https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/dev/shaefer/15` if you don't change any of the default project settings.
2828
1. Run it locally `serverless invoke local --function exampleFunction --path test/shaefer/get-local.json` This is like hitting your lambda live with the earlier mentioned URI.
2929
1. Run `serverless deploy` to create the lambda and dynamodb table in AWS. The output for the deploy will show success and give you the url for the deployed API gateway endpoint that you can hit to test it live.
30-
1. *OPTIONAL BUT IMPORTANT*: If you forgot something and want to rollback...**BEFORE** you change anything in the serverless.yml just run a `serverless remove` and it will delete all the resources it just created...or try to. Since serverless created everything with Cloudformation it can remove it too. More nuance `serverless remove --stage dev --region us-west-2`
30+
1. *OPTIONAL BUT IMPORTANT*: If you forgot something and want to rollback...**BEFORE** you change anything in the serverless.yml just run a `serverless remove` and it will delete all the resources it just created...or try to. Since serverless created everything with Cloudformation it can remove it too. Find more details in the [serverless docs](https://www.serverless.com/framework/docs/providers/aws/cli-reference/remove/).
3131

0 commit comments

Comments
 (0)