Serverless Framework (BETA)

This is a fork version of the serverless framework based on version 0.5.6. I added ap-southeast-1 (Singapore) to support our current project.

Serverless is the application framework for building web, mobile and IoT applications exclusively on Amazon Web Services' Lambda and API Gateway. It's a command line interface that helps you build and maintain serverless apps across teams of any size. It's also completely extensible via Plugins. We believe AWS Lambda will be the focal point of the AWS cloud, and the Serverless Framework interprets AWS from Lambda's perspective.

Features

• Run/test AWS Lambda functions locally, or remotely
• Auto-deploys, versions & aliases your Lambda functions
• Auto-deploys your REST API to AWS API Gateway
• Auto-deploys your Lambda events
• Support for multiple stages
• Support for multiple regions within stages
• Support for separate credentials per stage
• Manage & deploy AWS CloudFormation resources to each stage/region
• Project Variables allow staged/regional values in config files
• Project Templates reduce configuration
• Environment variable support
• Assign multiple endpoints and events to a function
• Interactive CLI dashboard to easily select and deploy functions and endpoints
• Optimize your Lambda functions for faster response times
• Support for API Gateway custom authorizers
• Project files can be published to npm
• 100% Extensible - Extend or modify the Framework and its operations via Plugins
• Powerful classes and methods for easy plugin development
• AWS best practices and optimizations built in
• A fantastic and welcoming community!

Getting Started

Install The Serverless Framework via npm: (requires Node V4)

npm install serverless-framework-0.56 -g

You can either install an existing project or create your own. We recommend starting out with the Serverless-Starter

serverless project install serverless-starter

Or you can create your own project

serverless project create

Refer to our documentation for more info. Enjoy!

Plugins

Serverless is composed of Plugins. A group of default Plugins ship with the Framework, and here are some others you can add to improve/help your workflow:

• Meta Sync - Securely sync your the variables in your project's _meta/variables across your team.
• Offline - Emulate AWS Lambda and Api Gateway locally to speed up your development cycles.
• Hook Scripts - Easily create shell script hooks that are run whenever Serverless actions are executed.
• CORS - Adds support for CORS (Cross-origin resource sharing).
• Serve - Simulate API Gateway locally, so all function calls can be run via localhost.
• Webpack - Use Webpack to optimize your Serverless Node.js Functions.
• Serverless Client - Deploy and config a web client for your Serverless project to S3.
• Alerting - This Plugin adds Cloudwatch Alarms with SNS notifications for your Lambda functions.
• Optimizer - Optimizes your code for performance in Lambda. Supports coffeeify, babelify and other transforms
• CloudFormation Validator - Adds support for validating your CloudFormation template.
• Prune - Delete old versions of AWS lambdas from your account so that you don't exceed the code storage limit.
• Base-Path - Sets a base path for all API Gateway endpoints in a Component.
• Test - A Simple Integration Test Framework for Serverless.
• SNS Subscribe - This plugin easily subscribes your lambda functions to SNS notifications.
• JSHint - Detect errors and potential problems in your Lambda functions.
• ESLint - Detect errors and potential problems in your Lambda functions using eslint.
• Mocha - Enable test driven development by creating test cases when creating new functions
• Function-Package - Package your lambdas without deploying to AWS.
• Sentry - Automatically send errors and exceptions to Sentry.
• Auto-Prune - Delete old AWS Lambda versions.

Consultants

These consultants use the Serverless Framework and can help you build your serverless projects.

• Trek10
• Parallax – they also built the David Guetta Campaign
• Just Serverless
• SC5 Online
• Carrot Creative
• microapps
• Apiwise
• Useful IO - and Hail Messaging
• WhaleTech
• CloudNative
• Hop Labs
• Webscale
• API talent - who also run Serverless-Auckland Meetup