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
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
export const hello = async (event, context) => {
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)
);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.
To create a new Serverless project.
$ serverless install --url https://github.com/AnomalyInnovations/serverless-nodejs-starter --name my-projectEnter the new directory
$ cd my-projectInstall the Node.js packages
$ npm installTo run a function on your local
$ serverless invoke local --function helloTo simulate API Gateway locally using serverless-offline
$ serverless offline startDeploy your project
$ serverless deployDeploy a single function
$ serverless deploy function --function helloRun your tests using
$ npm testWe use Jest to run our tests. You can read more about setting up your tests here.
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.
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.
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: falseTo override the default config, add a .eslintrc.json file. To ignore ESLint for specific files, add it to a .eslintignore file.
- 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.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent