mausconi / serverless-dynamodb-api-boilerplate

Production-ready Serverless API with DynamoDB, Typescript and best practices

Serverless DynamoDB API Boilerplate

Kickstart your Cloud-native and Serverless project in minutes. This is work in progress

---

About

This repository is a result of many lessons from launching variety of Serverless powered applications to the production. It was created according to many best practices and aims to provide developers a rapid start while also being production-ready.

Features

• Written in Typescript, compiled by Webpack using Serverless Webpack plugin. Optimized for huge projects where Out of Memory errors are frequent
• Works fully offline thanks to Serverless Offline and DynamoDB Local ran using Docker Compose
• Testable using Jest
• Interacts with DynamoDB using DocumentClient and DynamoDB Toolbox
• Works with both REST and GraphQL
• Managable - To avoid spaghetti code, serverless.yml is divided into logical parts. Functions' code is placed next to their definitions.

Quick start

Prerequisites:

• Serverless Framework
• Node.js
• Git

Start by pulling this repo using git:

git clone https://github.com/Dynobase/serverless-dynamodb-api-boilerplate

Or using Serverless Framework:

serverless create --template-url https://github.com/Dynobase/serverless-dynamodb-api-boilerplate --path myService

Once ready, install dependencies:

yarn

After that, start the project locally:

docker-compose up -d # To start DynamoDB local
yarn dev

Deploying

...

Contributing

Contributions are more than welcome.

Licensing

This project is licensed under the MIT License.