Serverless TypeScript Template

This template provides an opinionated setup for a Serverless TypeScript project.

Serverless Framework

This template uses the Serverless Framework fork osls to deploy the service. It comes with built-in TypeScript types and supports Lambda functions written in ESM and TypeScript.

See serverless.ts for the service configuration and the docs for more information.

Getting Started

1. Create a new repository

Create a new repository using this template

2. Replace placeholders

Replace all occurences of the following placeholders with the correct values:

Placeholder	File	Description
<SERVICE>	serverless.ts	Your service name
<PACKAGE>	package.json	Your package name
<DESCRIPTION>	package.json	Your package description
<USERNAME>	package.json	Your GitHub username
<REPO>	package.json	Your repository name
<AUTHOR>	package.json	Your name
<LICENSE>	package.json	Your license

3. Install, Build, Test, Deploy

Verify your project is working by running install, build, test, and deploy:

pnpm install
pnpm build
pnpm test
pnpm deploy

Happy coding! 🎉