glaciannex / generator-lambda-node

Yeoman Generator. Generates basic scaffolding for a new AWS Lambda. Provides basic tools to deploy it.

QuickStart: AWS Lambda Node

This package is meant to provide quick scaffolding for AWS Lambda function that use Node. The goal is to give you basic tools needed to jump start the develoment.

Below is the list of components that this template initilizes.

Usage

Install Yeoman

npm install -g yo

Install generator-aws-lambda-node

npm install -g aws-lambda-node

Run

Create New Project Directory

mkdir my-project && cd $_

Run generator-aws-lambda-node

yo generator-aws-lambda-node

Initialized Components

Package.json

• Basic information

  • Name
  • Description
  • Author

• Dev Dependencies

  • ESLint - linting framework
  • ESLint AirBnB - linting standards
  • Grunt - deployment automation
  • Chai - assertion framework
  • Sinon - mocking framework
  • Mocha - testing framework

• Dependencies

  • config - configuration framework
  • aws-sdk - AWS SDK
  • bluebird - Promise framework

Git

• Adding .gitignore

Node

• Basic lambda entry point

Grunt

• Package, and deploy project code to lambda(s)
• Populate lambda environment variables

ESLint

• Add AirBnB linting rule
• QoL rule overrides that make sense in context of lambda development

Config

• Default configuration file
• AWS Deployment Defaults
  • Default AWS deploy region
  • Deployment lambda names
  • Environment vairalbes for lambda