https://github.com/amazingustav/serverless-boilerplate

Boilerplate using Typescript with Serverless Framework
https://github.com/amazingustav/serverless-boilerplate

api-gateway aws-lambda cloudwatch prettier serverless-framework typescript vitest yarn

Last synced: 20 days ago
JSON representation

Boilerplate using Typescript with Serverless Framework

• Host: GitHub
• URL: https://github.com/amazingustav/serverless-boilerplate
• Owner: amazingustav
• Created: 2024-12-27T17:12:56.000Z (20 days ago)
• Default Branch: main
• Last Pushed: 2024-12-27T17:33:09.000Z (20 days ago)
• Last Synced: 2024-12-27T18:28:34.119Z (20 days ago)
• Topics: api-gateway, aws-lambda, cloudwatch, prettier, serverless-framework, typescript, vitest, yarn
• Language: TypeScript
• Homepage:
• Size: 126 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  Serverless Boilerplate



## 🎯 Project features

### Tech Stack

- [json-schema-to-ts](https://github.com/ThomasAribart/json-schema-to-ts) - uses JSON-Schema definitions used by API Gateway for HTTP request validation to statically generate TypeScript types in your lambda's handler code base

- [middy](https://github.com/middyjs/middy) - middleware engine for Node.js lambda. This template uses [http-json-body-parser](https://github.com/middyjs/middy/tree/master/packages/http-json-body-parser) to convert API Gateway `event.body` property, originally passed as a stringified JSON, to its corresponding parsed object

- [@serverless/typescript](https://github.com/serverless/typescript) - provides up-to-date TypeScript definitions for your `serverless.ts` service file

- [serverless-prune-plugin](https://github.com/claygregory/serverless-prune-plugin) - prunes old lambda versions.

- [serverless-plugin-aws-alerts](https://github.com/ACloudGuru/serverless-plugin-aws-alerts) - creates alerts automatically in CloudWatch.

- [serverless-plugin-canary-deployments](https://github.com/davidgf/serverless-plugin-canary-deployments) - implement canary deployments of Lambda functions with AWS CodeDeploy.

## 🔥 How to use the template

1. Create a new repo using this template

2. Clone your new project

3. Replace the standard names on the template (`ctrl + shift + f` in VSCode):

   1. `serverless-boilerplate` to your ``;

   3. `myFunction` to your ``.

4. Replace folder `myFunction` to your ``.

## 🛝 How to run

First, make sure you have installed [Node.js](https://nodejs.org/en/download/) (Node 16.17.0 or later) and the classic [Yarn](https://classic.yarnpkg.com/lang/en/) dependency.

Clone the project, then install the dependencies:

```bash

yarn bootstrap

```