Giter Club home page Giter Club logo

generator-sls's Introduction

Generator Serverless

NPM Badge Codacy Badge FOSSA Status HitCount

Yeoman generator for a lambda Serverless project

Requirements

  • Language of choice (Go 1.11, Python 2.7+, NodeJS 6+, .NET Core 2+, Java 8)
  • Yeoman >= V1.8.5

Generator installation

  1. you are going to need Yeoman:
npm install -g yo
  1. 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

  • Support of AWS SAM
  • Support of Serverless
  • Local Invoke/Debug
  • Supports Go 1.11, Python 2.7+, .NET Core 2+, Java 8+

Roadmap

  • Support of Go โœ…
  • Support of NodeJS ๐Ÿ•—
  • Support of Python โœ…
  • Support of Java โœ…
  • Support of C# โœ…
  • Support of different types of events for lambda function,
  • Simplifying local invoke/debug of lambda or apis (Support of SAM)
  • Orchestration and support of domains
  • Deployment using (Terraform, Amplify, SAM, Apex, or Serverless)
  • Auto generate scripts for simplifying serverless development in different IDEs (Visual Studio Code, Intellij, PyCharm, WebStorm, and Goland)
  • Choose Unit test framework to be used

Resources

License

FOSSA Status

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.