-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
38 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,38 @@ | ||
| # AWS Serverless Boilerplate | ||
| This boilerplate contains, | ||
| - AWS Lambda Functions | ||
| - AWS API Gateway | ||
| - Request Mapping Templates | ||
| - Dynamodb table templates | ||
| - IAM Roles Definition | ||
| - AWS Custom Authorizer Authentication | ||
| - CRUD for sample TODO application | ||
| - Angular client that utilizes the API. | ||
|
|
||
| ## Prerequisite | ||
| - Install serverless rc1 | ||
| ``` npm install serverless -g ``` | ||
| - Make sure you have setup aws credentials with your aws account. if not follow the guide here. http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html | ||
|
|
||
| ## Deploy resources, functions and endpoints | ||
| ``` | ||
| cd api | ||
| serverless deploy | ||
| ``` | ||
|
|
||
| ## Starting the client | ||
| ``` | ||
| cd client | ||
| npm Install | ||
| node client.js | ||
| ``` | ||
| Visit ```localhost:3000``` | ||
| serverless-react-boilerplate | ||
| ============================ | ||
|
|
||
| [](http://www.serverless.com) | ||
| [](https://www.npmjs.com/package/serverless-dynamodb-local) | ||
|
|
||
| ## This Plugin Requires | ||
| * Serverless [email protected] | ||
|
|
||
| ## Features | ||
| * Support offline development with dynamodb, lambda and API Gateway | ||
| * Support local dynamodb seeds/migrations | ||
| * Build automation in client and server to ease local development | ||
| * Rich request template | ||
| * Lambda CRUD operations for a Todo application | ||
| * React web application to utilize the API | ||
|
|
||
| ## Installing Dependencies. | ||
|
|
||
| * Run `npm install` inside the root folder, serverless folder and web folder. | ||
|
|
||
| ## Starting server and client. | ||
|
|
||
| * Run `npm run app` from the root folder. | ||
| * Visit `http://localhost:8080` | ||
|
|
||
| ## Deploy server to AWS | ||
|
|
||
| * Run `npm run deploy` | ||
|
|
||
|
|
||
| ## Links | ||
| * [serverless-dynamodb-local plugin](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html) | ||
| * [serverless-offline plugin](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html) | ||
|
|
||
|
|
||
| ## License | ||
| [MIT](LICENSE) |