Skip to content
This repository was archived by the owner on Jun 27, 2023. It is now read-only.

README.md

Latest commit

 

History

History
58 lines (39 loc) · 1.3 KB

README.md

File metadata and controls

58 lines (39 loc) · 1.3 KB

lambda-micro-boilerplate Build Status

Github | NPM | Travis

About

lambda-micro-boilerplate provides a simple template with a minimal dependency footprint for AWS Lambda projects. It uses lambda-api to manage routing.

Install

PROJECT_DIRECTORY="my-lamda-api"
git clone --depth=1 git@github.com:Sleavely/lambda-micro-boilerplate.git $PROJECT_DIRECTORY
cd $PROJECT_DIRECTORY
rm -rf .git/
npm install

Quick Start

  1. Modify routes in api.js
  2. Run node local.js to start your API locally
  3. ???
  4. Deploy your AWS Lambda function with lambda.handler as your handler

Bootstrap Checklist

The slightly longer version:

  • Change or update the LICENSE
  • Update package.json:
    • name
    • description
    • repository
    • keywords
    • author
    • license
  • git init
  • Replace this README with something useful.

License

The license declaration can be found in LICENSE. (It's MIT)