Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rogerwelin committed Feb 10, 2020
1 parent 9f69e39 commit d8766c6
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion tmpl-readme.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ package main
const reamdeFile = `
## API GW Project
### Set up the Environment
To create the API GW project you will need an AWS account and generate API keys for your IAM user. Run *aws configure* after installing the awscli. Then you you will need to create a new S3 bucket that will be used for storing deployment files.
### Install Dependencies
You need the following dependencies to be able to build and deploy the api project:
* A working Pyhton installation
* awscli
* sam (serverless application model)
* create a new S3-bucket to store deployment files
**Install awscli and SAM**
` + "```" + `bash
Expand All @@ -26,5 +28,7 @@ $ sam package --template-file apigw.yml --output-template-file out.yaml --s3-bu
$ sam deploy --template-file ./out.yaml --stack-name your-api-project --capabilities CAPABILITY_IAM
` + "```" + `
Go to the AWS console > Cloudformation. Make sure the Cloudformations stack finishes. Take a look at the output to get the URL of your newly created API project. Either curl the address at the /hello endpoint or run the endpoint directly in the API Gateway console.
`

0 comments on commit d8766c6

Please sign in to comment.