kyledetella / typescript-ncc-serverless-template

A TypeScript + ncc + Serverless starter kit

TypeScript ncc serverless Template

Quickly bootstrap a serverless project.

This creates a serverless project fronted by API Gateway. For a project with direct invocation, see: typescript-ncc-serverless-template-direct.

Features:

• TypeScript (compiled using ncc)
• Jest configured out-of-the-box
• Local development via serverless-offline

Table of Contents

• TypeScript ncc serverless Template
  • Usage
  • Development
    • Install dependencies
    • Testing locally
  • Testing
  • Deployment

Usage

npx serverless create --template-url https://github.com/kyledetella/typescript-ncc-serverless-template --path <your_app> && \
cd <your_app>

Inside of your new app directory, run:

nvm use && npm i

Development

Install dependencies

nvm use && npm i

Testing locally

This project uses serverless-offline to emulate API Gateway and Lambda functionality.

npm start

The service will be available at http://localhost:4144.

curl -X POST -d '{"foo": "bar"}' http://localhost:4144

Testing

npm t

To run in watch mode:

npm run test:watch

Deployment

npm run deploy