README.md

Documentation

Go to Docs

Compatibility

serverless-leo version 3 is compatible with serverless@2 and serverless@3

serverless@1 is not supported

Examples

NodeJS

NodeJS Lambda Layer

Python

Java

Starting a new project with example bots

serverless create --template-url https://github.com/LeoPlatform/serverless-leo/tree/master/templates/microservice -p my-microservice
cd my-microservice
npm install
serverless create bot --name my-bot-name --type load --language node --destination my-write-queue

At this point, you will have a new project with a bots directory including your new bot. There are two things to setup before your service can be deployed.

1. Set the name and deploymentBucket of your service in the root serverless.yml file
2. Update the leo_config.js file to include the leo bus values your service will use

Rust specific

1. In order to register this lambda in your workspace, you need to add the relative path to the newly created folder in your root cargo.toml workspace members.
2. Update the bus_config() of the main.rs in your newly created bot template to have the correct provider information.

Once you've made these changes, you can run serverless deploy which will use your default AWS_PROFILE.

Developing on this Project Locally

1. Clone project locally
2. Run npm link in this project's /src directory.
3. In a test project, run npm link serverless-leo.
   • At this point, any serverless commands will use your local serverless-leo plugin

Additionally, if you are making bot template changes, you can temporarily add this to the bottom of create:bot:copy-template hook in order to use local path files instead of the repo url.

this.options['template-path'] = path.resolve(`${__dirname}/../templates/bot/${language}/${type}`)
delete this.options['template-url']