Serverless-Starter-Service API

A Serverless API MicroService that adds ES7 syntax, serverless-offline, environment variables, and unit test support. Part of the Serverless Tutorial Series.

The Serverless Tutorial Series uses the serverless-webpack plugin, Babel, serverless-offline, and Jest. This service supports the following features:

ES7 script is supported in all Lambdas
- Use import and export
Bundle Lambda functions using Webpack
Execute API Gateway locally
- Use serverless offline start
Added Support for unit testing
- Run npm test to run your tests
Sourcemaps enable debugging and error messages
- Error message show the correct line numbers
- Works in production with AWSCloudWatch
Automatic support for multiple handler files
- You do not have to add a new entry your webpack.config.js
Add environment variables for each stage deployed

Demo

A demo version of this service is hosted on AWS - https://g0xd40o7wd.execute-api.us-east-1.amazonaws.com/dev/starterService

And here is an example of the ES7 source behind it

const message = ({time, ...rest}) => new Promise((resolve, reject) => setTimeout(() => {
  resolve(`${rest.copy} (with a delay)`);
}, time * 1000)
);

export const starterService = async (event, context, callback) => {
  const response = {
    statusCode: 200,
    body: JSON.stringify({
      message: `You are now Serverless on AWS! ${(await message({ time: 1, copy: "Your serverless lambda has executed as it should!"}))}`,
      input: event
    })
  };

  callback(null, response);
};

Requirements

Installation

To create a new Serverless project.

$ serverless install --url https://github.com/lopezdp/ServerlessStarterService --name microservice-project

Enter the new directory

$ cd microservice-project

Install the Node.js packages

$ npm install

Usage

To run eslint on your local

$ npm run lint

To run unit tests on your local

$ npm run test

To run a function on your local

$ serverless invoke local --function hello

To simulate APIGateway locally using serverless-offline

$ serverless offline start

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

Rename env.example to env.yml.
Add environment variables for the various stages to env.yml.
Uncomment environment: ${file(env.yml):${self:provider.stage}} in the serverless.yml.
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

The Serverless Tutorial Series is maintained by David Lopez (@davidplopez). Subscribe to our newsletter (Coming Soon!) for updates. Send us an email if you have any questions.

lopezdp / invoice-log-api