Skip to content

Command line tool to locally run and deploy your node.js application to Amazon Lambda

Notifications You must be signed in to change notification settings

devops-at-alinea/node-lambda

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

node-lambda

node-lambda

Command line tool to locally run and deploy your node.js application to Amazon Lambda.

BuildStatus NPM version

node-lambda run

Installation

npm install -g node-lambda

Example App

The node-lambda-template example app makes it easy to get up and running.

Usage

There are 3 available commands.

node-lambda setup
node-lambda run
node-lambda deploy

Commands

setup

Initializes the event.json and .env files. event.json is where you mock your event. .env. is where you place your deployment configuration.

$ node-lambda setup --help

  Usage: run [options]

  Options:

    -h, --help                     output usage information

After running setup, it's a good idea to gitignore the generated event.json and .env file.

echo ".env\nevent.json" >> .gitignore

run

Runs your Amazon Lambda index.js file locally. Passes event.json data to the Amazon Lambda event object.

$ node-lambda run --help

  Usage: run [options]

  Options:

    -h, --help                     output usage information
    -h, --handler [index.handler]  Lambda Handler {index.handler}

deploy

Bundles and deploys your application up to Amazon Lambda.

$ node-lambda deploy --help

  Usage: deploy [options]

  Options:

    -h, --help                        output usage information
    -e, --environment [staging]       Choose environment {development, stating, production}
    -a, --accessKey [your_key]        AWS Access Key
    -s, --secretKey [your_secret]     AWS Secret Key
    -r, --region [us-east-1]          AWS Region(s)
    -v, --version [custom-version]    Lambda Version
    -n, --functionName [node-lambda]  Lambda FunctionName
    -h, --handler [index.handler]     Lambda Handler {index.handler}
    -c, --mode [event]                Lambda Mode
    -o, --role [your_role]            Amazon Role ARN
    -m, --memorySize [128]            Lambda Memory Size
    -t, --timeout [3]                 Lambda Timeout
    -d, --description [missing]       Lambda Description
    -u, --runtime [nodejs]            Lambda Runtime

Other AWS Lambda Tools Projects

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Running tests

npm install
npm test

About

Command line tool to locally run and deploy your node.js application to Amazon Lambda

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%