Serverless Template

Template repository for Serverless AWS Lambda apps using the Serverless Framework

Overview

Run fast with a new AWS Lambda serverless project using a quick and dirty TypeScript stack!

Stack

• Framework
  • Serverless
    • Includes serverless-offline for a local stack
• Testing
  • Vitest (test runner)
  • XO (code linting)

How to use

1. Create a new repository using this as a template
2. npm i to get the dependencies installed
3. Modify the package.json and this readme to fit your project
4. Run the local build with npm run serve! (alternatively serve:watch will run with nodemon)

Deploying

1. Create your .env file based on the included .example.env
2. Run npm run deploy to deploy to a dev stage, or npm run deploy:production to deploy to production.

Q + A

Why Vitest? Why not Jest?

• Personal preference. Vitest is so smooth.

Why use such a strict linter?

• I like clean code, and personally it forces me to write more readable code. The style is automagically enforced by Prettier anyways.

TODO:

• Write better docs.