Serverless Node.js Starter
Now that we know how to set our Serverless projects up, it makes sense that we have a good starting point for our future projects. For this we created a couple of Serverless starter projects that you can use called, Serverless Node.js Starter. We also have a Python version called Serverless Python Starter. Our starter projects also work really well with Seed; a fully-configured CI/CD pipeline for Serverless Framework.
Serverless Node.js Starter uses the serverless-webpack plugin, Babel, and Jest. It supports:
- Use async/await in your handler functions
- Support for unit tests
- Run
npm test
to run your tests
- Run
- Sourcemaps for proper error messages
- Error message show the correct line numbers
- Works in production with CloudWatch
- Automatic support for multiple handler files
- No need to add a new entry to your
webpack.config.js
- No need to add a new entry to your
Demo
A demo version of this service is hosted on AWS - https://cvps1pt354.execute-api.us-east-1.amazonaws.com/dev/hello
.
And here is the ES7 source behind it.
export const hello = async (event, context, callback) => {
const response = {
statusCode: 200,
body: JSON.stringify({
message: `Go Serverless v1.0! ${(await message({ time: 1, copy: 'Your function executed successfully!'}))}`,
input: event,
}),
};
callback(null, response);
};
const message = ({ time, ...rest }) => new Promise((resolve, reject) =>
setTimeout(() => {
resolve(`${rest.copy} (with a delay)`);
}, time * 1000)
);
Requirements
- Configure your AWS CLI
- Install the Serverless Framework
npm install serverless -g
Installation
To create a new Serverless project with ES7 support.
$ serverless install --url https://github.com/AnomalyInnovations/serverless-nodejs-starter --name my-project
Enter the new directory.
$ cd my-project
Install the Node.js packages.
$ npm install
Usage
To run a function on your local
$ serverless invoke local --function hello
Run your tests
$ npm test
We use Jest to run our tests. You can read more about setting up your tests here.
Deploy your project
$ serverless deploy
Deploy a single function
$ serverless deploy function --function hello
So give it a try and send us an email if you have any questions or open a new issue if you’ve found a bug.
If you liked this post, please subscribe to our newsletter and give us a star on GitHub.
For help and discussion
Comments on this chapter