A Serverless starter that adds ES6, TypeScript, serverless-offline, linting, environment variables, and unit test support. Part of the Serverless Stack guide.
Serverless Node.js Starter uses the serverless-bundle plugin and the serverless-offline plugin. It supports:
- Generating optimized Lambda packages with Webpack
- Using ES6 or TypeScript in your handler functions
- Run API Gateway locally
- Use
serverless offline start
- Use
- Support for unit tests
- Run
npm testto run your tests
- Run
- 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://z6pv80ao4l.execute-api.us-east-1.amazonaws.com/dev/hello
And here is the ES6 source behind it
return {
statusCode: 200,
body: JSON.stringify({
message: `Go Serverless v1.0! ${(await message({ time: 1, copy: 'Your function executed successfully!'}))}`,
input: event,
}),
};
};
const message = ({ time, ...rest }) => new Promise((resolve, reject) =>
setTimeout(() => {
resolve(`${rest.copy} (with a delay)`);
}, time * 1000)
);
Upgrading from v1.x
We have detailed instructions on how to upgrade your app to the v2.0 of the starter if you were using v1.x before. Read about it here.
Requirements
Installation
To create a new Serverless project.
Enter the new directory
Install the Node.js packages
Usage
To run a function on your local
To simulate API Gateway locally using serverless-offline
Deploy your project
Deploy a single function
Running Tests
Run your tests using
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
- Rename
env.exampleto.env. - Add environment variables for your local stage to
.env. - Uncomment
environment:block in theserverless.ymland reference the environment variable as${env:MY_ENV_VAR}. WhereMY_ENV_VARis added to your.envfile. - Make sure to not commit your
.env.
TypeScript
If serverless-bundle detects a tsconfig.json in your service root, it'll compile it using TypeScript. We have a separate starter for TypeScript here, Serverless TypeScript Starter.
Linting
We use ESLint to lint your code via serverless-bundle.
You can turn this off by adding the following to your serverless.yml.
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 Serverless Stack.