https://github.com/intersective/generator-sls-lambda

This is a scaffolding tool that you can use to quickly create a new project with serverless, lambda function and TypeScript.
https://github.com/intersective/generator-sls-lambda

Last synced: 5 months ago
JSON representation

This is a scaffolding tool that you can use to quickly create a new project with serverless, lambda function and TypeScript.

• Host: GitHub
• URL: https://github.com/intersective/generator-sls-lambda
• Owner: intersective
• License: mit
• Created: 2021-01-18T13:09:01.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-12T02:28:23.000Z (over 3 years ago)
• Last Synced: 2025-10-19T14:42:38.382Z (8 months ago)
• Language: TypeScript
• Size: 246 KB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

          
[![npm version](https://badge.fury.io/js/generator-sls-lambda.svg)](https://www.npmjs.com/package/generator-sls-lambda)

# sls-lambda

This is a scaffolding tool that you can use to quickly create a new project with serverless, lambda function and TypeScript.

## How to use

### Installation

1. run `npm install -g yo` to install [yeoman](https://yeoman.io/)

1. run `npm install -g generator-sls-lambda` to install generator-sls-lambda

1. run `yo sls-lambda newapp` to create a new project under folder `newapp`

1. follow the instructions and choose the package that you need

### Run serverless

1. go to the new folder that you've just created `cd newapp`

1. run `npm run dev` to start the serverless server

1. send a GET request to `http://127.0.0.1:3000/dashboard` to test the server

## Development

1. run `npm install -g yo` to install [yeoman](https://yeoman.io/)

1. run `npm link` under the directory of `generator-sls-lambda` to link this module as a global module on your local machine

1. you will be able to run `yo sls-lambda newapp` to create new app now

## Tools & Packages

- ExpressJS

  - express

  - cors

  - dotenv

- Serverless Framework

  - serverless

  - serverless-http

  - serverless-offline

  - serverless-plugin-typescript

  - serverless-certificate-creator

  - serverless-domain-manager

- [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools)(Logging System)

  - @dazn/lambda-powertools-logger

  - @dazn/lambda-powertools-pattern-basic

  - @dazn/lambda-powertools-http-client

- TypeScript

  - @types/cors

  - @types/express

  - typescript

  - eslint

  - @typescript-eslint/parser

  - @typescript-eslint/eslint-plugin

  - @typescript-eslint/eslint-plugin-tslint

- [Jest](https://jestjs.io/en)

  - jest

  - jest-express

  - ts-jest

- GitHub Action Flows

- [Jwt Parser](https://github.com/intersective/jwt-parser)

  - @practera/jwt-parser

- DynamoDB

  - @dazn/lambda-powertools-dynamodb-client

  - serverless-dynamodb-local

  - aws-sdk

- SonarCloud

  - jest-sonar-reporter

- GraphQL

  - apollo-datasource

  - apollo-datasource-rest

  - apollo-server-lambda

  - dataloader

  - graphql

  - graphql-tag

  - @2fd/graphdoc

  - @types/aws-lambda

  - apollo-server-testing