Skip to content

Latest commit

 

History

History
131 lines (91 loc) · 3.95 KB

README.md

File metadata and controls

131 lines (91 loc) · 3.95 KB
Raw

Serverless Node.js Starter

A Serverless starter that adds ES7 syntax, serverless-offline, environment variables, and unit test support. Part of the Serverless Stack guide.

Serverless Node.js Starter uses the serverless-webpack plugin, Babel, serverless-offline, and Jest. It supports:

  • ES7 syntax in your handler functions
    • Use import and export
  • Package your functions using Webpack
  • 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
  • Automatic support for multiple handler files
    • No need to add a new entry to your webpack.config.js
  • Add environment variables for your stages

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 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

Installation

To create a new Serverless project.

$ 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 unit tests on your local

$ npm test

To run a function on your local

$ serverless invoke local --function hello

To simulate API Gateway locally using serverless-offline

$ serverless offline start

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

To add another function as a new file to your project, simply add the new file and add the reference to serverless.yml. The webpack.config.js automatically handles functions in different files.

To add environment variables to your project

  1. Rename env.example to env.yml.
  2. Add environment variables for the various stages to env.yml.
  3. Uncomment environment: ${file(env.yml):${self:provider.stage}} in the serverless.yml.
  4. Make sure to not commit your env.yml.

Support

  • Send us an email if you have any questions
  • Open a new issue if you've found a bug or have some suggestions.
  • Or submit a pull request!

Maintainers

Serverless Node.js Starter is maintained by Frank Wang (@fanjiewang) & Jay V (@jayair). Subscribe to our newsletter for updates. Send us an email if you have any questions.