A Serverless starter that adds TypeScript, serverless-offline, linting, environment variables, and unit test support.
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:
serverless offline start
npm test
to run your testsA 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,
}),
};
}
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
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
Run your tests using
$ npm test
We use Jest to run our tests. You can read more about setting up your tests here.
To add environment variables to your project
env.example
to .env
..env
.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..env
.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.
This repo is maintained by Anomaly Innovations; makers of Seed and Serverless Stack.