https://github.com/sc5/sc5-aws-lambda-boilerplate

Boilerplate for creating AWS lambda functions using node.js
https://github.com/sc5/sc5-aws-lambda-boilerplate

Last synced: 8 days ago
JSON representation

Boilerplate for creating AWS lambda functions using node.js

• Host: GitHub
• URL: https://github.com/sc5/sc5-aws-lambda-boilerplate
• Owner: SC5
• License: mit
• Created: 2015-07-15T10:02:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-03T05:47:45.000Z (about 9 years ago)
• Last Synced: 2024-04-13T11:21:32.798Z (7 months ago)
• Language: JavaScript
• Size: 170 KB
• Stars: 9
• Watchers: 23
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SC5 AWS LAMBDA MICROSERVICE BOILERPLATE

A boilerplate for developing, testing and deploying AWS Lambda functions using node.js

## Installation

### Prerequisites 

Clone the project and trigger installation of the project dependencies by

    > git clone https://github.com/SC5/sc5-aws-lambda-boilerplate.git [module name]

    > cd [module name]

    > npm install

Set up your AWS credentials e.g. to ~/.aws/credentials (see http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html). e.g.

    

    [default]

    aws_access_key_id = [YOUR_ACCESS_KEY_ID]

    aws_secret_access_key = [YOUR_SECRET_ACCESS_KEY]

Set up your lambda environment by copying example_lambdaenv.json to lambdaenv.json and setting the parameter values. You will need an AWS IAM role for use with your Lambda function.

## Development

Set up your module information into package.json prior to deployment

### Project layout

    src/    The source of the Lambda function (index.js)

    tests/  The tests for the Lambda function. Tests to run must start with test_

    gulpfile.js     The gulpfile used for deployment

    package.json    The package file for the module. Defines the function name, version and dependencies

## Testing

Run gulp tests. 

    > gulp test

Tests reside in the tests/directory. Uses lambda-wrapper module to wrap the code.

## Deploying to AWS

The module is deployed to Lambda using

    

    > gulp deploy

This will create a new lamda function to the region defined in lambdaenv.json with the name [module_name]_[version] (cleaned up from illegal characters)

## Release History

* 2015/07/22 - v0.1.1 - Use lambda-wrapper instead of pseudolambda.

* 2015/07/15 - v0.1.0 - Initial version of boilerplate

## License

Copyright (c) 2015 [SC5](http://sc5.io/), licensed for users and contributors under MIT license.

https://github.com/sc5/grunt-bobrsass-boilerplate/blob/master/LICENSE-MIT

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/SC5/sc5-aws-lambda-boilerplate/trend.png)](https://bitdeli.com/free "Bitdeli Badge")