README.md

Serverless TypeScript Starter

A Serverless starter that adds TypeScript, serverless-offline, linting, environment variables, and unit test support.

This starter uses the serverless-bundle plugin and the serverless-offline plugin. It supports:

• Generating optimized Lambda packages with Webpack
• Using TypeScript in your handler functions and tests
• Run API Gateway locally
  • Use serverless offline start
• Support for unit tests
  • Run npm test to run your tests
• Sourcemaps for proper error messages
  • Error message show the correct line numbers
  • Works in production with CloudWatch
• Lint your code with ESLint
• Add environment variables for your stages
• No need to manage Webpack or Babel configs

---

Demo

A demo version of this service is hosted on AWS - https://ylsml6v6r6.execute-api.us-east-1.amazonaws.com/dev/hello

And here is the TS source behind it

export async function hello(
  event: APIGatewayEvent,
  context: Context
): Promise<APIGatewayProxyResult> {
  return {
    statusCode: 200,
    body: JSON.stringify({
      message: "Go Serverless v2.0! Your function executed successfully!",
      context,
      event,
    }),
  };
}

Requirements

• Install the Serverless Framework
• Configure your AWS CLI

Installation

To create a new Serverless project.

$ serverless install --url https://github.com/AnomalyInnovations/serverless-typescript-starter --name my-project

Enter the new directory

$ cd my-project

Install the npm packages

$ npm install

Usage

To run a function on your local

$ serverless invoke local --function hello

To simulate API Gateway locally using serverless-offline

$ serverless offline start

Deploy your project

$ serverless deploy

Deploy a single function

$ serverless deploy function --function hello

Running Tests

Run your tests using

$ npm test

We use Jest to run our tests. You can read more about setting up your tests here.

Environment Variables

To add environment variables to your project

1. Rename env.example to .env.
2. Add environment variables for your local stage to .env.
3. Uncomment environment: block in the serverless.yml and reference the environment variable as ${env:MY_ENV_VAR}. Where MY_ENV_VAR is added to your .env file.
4. Make sure to not commit your .env.

Linting

We use ESLint to lint your code via serverless-bundle.

You can turn this off by adding the following to your serverless.yml.

custom:
  bundle:
    linting: false

To override the default config, add a .eslintrc.json file. To ignore ESLint for specific files, add it to a .eslintignore file.

Support

• Open a new issue if you've found a bug or have some suggestions.
• Or submit a pull request!

---

This repo is maintained by Anomaly Innovations; makers of Seed and Serverless Stack.