|
1 | | -# AWS Serverless Boilerplate |
2 | | -This boilerplate contains, |
3 | | - - AWS Lambda Functions |
4 | | - - AWS API Gateway |
5 | | - - Request Mapping Templates |
6 | | - - Dynamodb table templates |
7 | | - - IAM Roles Definition |
8 | | - - AWS Custom Authorizer Authentication |
9 | | - - CRUD for sample TODO application |
10 | | - - Angular client that utilizes the API. |
11 | | - |
12 | | -## Prerequisite |
13 | | - - Install serverless rc1 |
14 | | - ``` npm install serverless -g ``` |
15 | | - - 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 |
16 | | - |
17 | | -## Deploy resources, functions and endpoints |
18 | | -``` |
19 | | - cd api |
20 | | - serverless deploy |
21 | | -``` |
22 | | - |
23 | | -## Starting the client |
24 | | -``` |
25 | | - cd client |
26 | | - npm Install |
27 | | - node client.js |
28 | | -``` |
29 | | -Visit ```localhost:3000``` |
| 1 | +serverless-react-boilerplate |
| 2 | +============================ |
| 3 | + |
| 4 | +[](http://www.serverless.com) |
| 5 | +[](https://www.npmjs.com/package/serverless-dynamodb-local) |
| 6 | + |
| 7 | +## This Plugin Requires |
| 8 | + |
| 9 | + |
| 10 | +## Features |
| 11 | +* Support offline development with dynamodb, lambda and API Gateway |
| 12 | +* Support local dynamodb seeds/migrations |
| 13 | +* Build automation in client and server to ease local development |
| 14 | +* Rich request template |
| 15 | +* Lambda CRUD operations for a Todo application |
| 16 | +* React web application to utilize the API |
| 17 | + |
| 18 | +## Installing Dependencies. |
| 19 | + |
| 20 | +* Run `npm install` inside the root folder, serverless folder and web folder. |
| 21 | + |
| 22 | +## Starting server and client. |
| 23 | + |
| 24 | +* Run `npm run app` from the root folder. |
| 25 | +* Visit `http://localhost:8080` |
| 26 | + |
| 27 | +## Deploy server to AWS |
| 28 | + |
| 29 | +* Run `npm run deploy` |
| 30 | + |
| 31 | + |
| 32 | +## Links |
| 33 | +* [serverless-dynamodb-local plugin](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html) |
| 34 | +* [serverless-offline plugin](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html) |
| 35 | + |
| 36 | + |
| 37 | +## License |
| 38 | + [MIT](LICENSE) |
0 commit comments