Serverless Examples

A collection of ready-to-deploy Serverless Framework services.

Table of Contents

Click to expand

• Getting Started
• Examples
• Community Examples
• Contributing
  • Adding example code
  • Adding a community example

Getting Started

If you are new to serverless, we recommend getting started with by creating an HTTP API Endpoint in NodeJS, Python, Java, or Golang.

Examples

Each example contains a README.md with an explanation about the service and it's use cases.

Have an example? Submit a PR or open an issue. ⚡️

To install any of these you can run:

serverless install -u https://github.com/serverless/examples/tree/master/folder-name -n my-project

Contributing

We are happy to accept more examples from the community.

Adding example code

1. Make sure your contribution matches the linting setup for this repo:

Run the linting via

npm run lint

2. Add a package.json file in your example with the name of the example and a description and any dependencies used.

3. Regenerate the README.md with the following command

npm run docs

4. Open a new pull request with your example.

Adding a community example

We love hearing about projects happening in the community. Feel free to add your serverless project to our growing list.

1. Add link, title, and description to the community-examples.json file.

2. Open a new pull request with your example.