README.md

Serverless + Koa + Typescript + Jest Starter Project

We often use Serverless for microservices. This is an opinionated starter project for serverless http microservices that uses;

• Serverless
• serverless-http
• serverless-webpack
• Koa
• Typescript
• Jest for testing
• Support for debugging via VisualStudioCode
• Node stack traces supporting sourcemaps

Why Koa?

We often use serverless functions for http microservices. These all require common functionality including:

• CORS
• Request Body Parsing
• Error handling
• Request validation
• And more...

Koa has a library of well maintained, tested & proven middleware to handle all of the above and much more. These are used by many people, have been designed with security in mind to prevent common attacks. There is no need to manually add CORS headers to responses, nor parse request bodies.

Installation

• Clone or download this project
• or $ serverless install --url https://github.com/jmannau/serverless-ts-template --name project-name

then

1. npm install or yarn install
2. npm test to run tests or npm test -- --watch to run the tests in watch mode.
3. npm run sls:offline to start the offline server using serverless-offline