Serverless-dynalite2-local NPM

serverless-dynalite-local

Serverless plugin to run DynamoDB locally with dynalite.

Motivation

When developing services in the Serverless Application Framework, it is common to use the serverless-offline plugin for local development. This plugin will enable you to run a local instance of DynamoDB, dynalite as well.

There are already some plugins out there that serves the same purpose, but they have some challenges.

serverless-dynamodb-local has a hard dependency on JRE, and is created to download the DynamoDB *.jar file before starting. While this might work on a local developer computer, it does not in a CI/CD environment. In addition, the serverless plugin does not support v2 and up.
serverless-dynalite comes with node-only dependencies, but has been unmaintained for a while and does not work on newer node runtimes.

We have, therefore, decided to create a new plugin which overcome the challenges from the above two plugins. We also have taken inspiration from serverless-s3-local, which does the same for AWS S3 with s3rver.

Usage

Install the plugin with yarn add --dev serverless-dynalite-local. Add serverless-dynalite-local to your serverless.yml plugins key, BEFORE serverless-offline.

By default the server will start up at http://localhost:4567 and use dynalite/ as a data directory. Connect to the database like this:

const client = new DynamoDBClient({
  endpoint: "http://localhost:4567",
});

The following options are supported in custom.dynalite in serverless.yml:

Option	Description	Type	Default value
port	The port to listen on	number	4567
path	The path to use for the LevelDB store	string	./dynalite
inMemory	Whether to only store data in memory (the path option will be ignored if this is true)	boolean	false