- Java Runtime Engine (JRE) version 6.x or newer to run dynamodb locally
- 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 with live reload
- React web application to utilize the API
We have used serverless-offline plugin and serverless-dynamodb-local plugin in this boilerplate. You can declare your table templates and seeds in offline/migrations
folder just like the todo.json
template. When you spin up the offline server, these tables will be used as the datasources for your lambda functions.
Thanks to the offline plugin's environment variable IS_OFFLINE
we can select between local dynamodb and aws dynamodb.
var dynamodbOfflineOptions = {
region: "localhost",
endpoint: "http://localhost:8000"
},
isOffline = () => process.env.IS_OFFLINE;
var client = isOffline() ? new AWS.DynamoDB.DocumentClient(dynamodbOfflineOptions) : new AWS.DynamoDB.DocumentClient();
###Directory structure
|──serverless
| |──handlers
| | |──todo
| | | |──lib
| | | | |──todo.js
| | | | |──helper.js
| | | |──handler.js
| |──database
| | |──dynamodb.js
| |──offline
| | |──migrations
| | | | |──todo.json
| |──resources
| |──test
| |──event.json
| |──templates.yml
| |──serverless.yml
| |──package.json
|──web
| |──src
| | |──components
| | |──index.js
| |──index.html
| |──package.json
| |──webpack.config.js
|──gulpfile.js
|──package.json
- Clone this repo.
- Make sure AWS credentials are setup properly. Otherwise refer this document
- Install webpack and serverless globally.
npm i -g webpack webpack-dev-server
npm i -g serverless
- Install project dependencies.
cd serverless-react-boilerplate
and type,
npm install
- Install dynamodb local. (Make sure you have Java runtime 6.x or newer)
npm run db-setup
- Run the client and server
npm run app
- Visit
http://localhost:8080
- Run
npm run deploy
Your contributions are much appriciated.
- Release v1.2 - added support for [email protected]
- Release v1.3 - fixed local dynamobd get packaged for deployment