msolimans / generator-sls

Yeoman generator for a lambda Serverless project
MIT License
29 stars 8 forks source link
aws dotnet-core goland golang idea java jetbrains lambda lambda-serverless nodejs pycharm python sam serverless visual-studio-code webstorm yeoman yeoman-generator

Generator Serverless

NPM Badge Codacy Badge FOSSA Status HitCount

Yeoman generator for a lambda Serverless project

Requirements

Generator installation

1) you are going to need Yeoman:

npm install -g yo

2) Install the generator:

npm i -g generator-sls

Usage

Base generator

Once the link established, you can use it right away. Create a new directory where you want your project to be and run it:

mkdir lambda-service
cd lambda-service
yo sls

It will prompt some questions you need to answer to configure your project. Default values are specified between parenthesis. You now have a starter skeleton for a lambda project!

Sub-generator

After creating project/service, you can easily add a function/route by using the subgenerator. In the root directory of your project, run:

yo sls:route

Just like the base generator, it will prompt you to give the function(s) name(s). It creates the handler files and modify the serverless.yml file according to.

Unit Testing

Generator unit tests

TODO

Project unit tests

For every route created with the generator, a corresponding basic unit test file is added.

Features

Roadmap

Resources

License

FOSSA Status