Netlify Functions examples

Hi there! This is a playground repo to test out Netlify’s Lambda Functions. You can see a live demo of the examples at https://functions-playground.netlify.com.

If you want your own copy to play around with, the quickest way to get it up and running is clicking the Deploy to Netlify button below. It will clone this repository into your own account, and deploy the site to Netlify.

Table of Contents

• Setup
• Running the examples
• Community Function Examples
• Contributing
  • Adding an example

Setup

To run the examples locally, here’s what you’ll need:

System Requirements:

• git
• NodeJS 8 or greater
• yarn

cd into your local copy of the repository and run yarn or npm install

cd netlify-functions-example
yarn

Running the examples

yarn start

This will start the client server on http://localhost:8080, and the netlify-lambda server on http://localhost:9000.

netlify-lambda isn’t required to deploy Lambda functions to Netlify, but it offers some handy features out of the box that make it quicker to get started, like the local dev server and nice defaults for transpiling and bundling functions in production.

The client server is configured to proxy /.netlify requests to the Lambda server (see webpack.client.js). This is the same behavior the site has when it’s deployed to Netlify.

Community Function Examples

Add an example

Contributing

We are happy to accept more examples from the community

Adding an example

1. Add your example to examples.json

Make sure to include the following fields. If there is no live demo/blog post etc, you can omit the url from the object.

{
  "name": "netlify-functions-apollo-graphql",
  "description": "Deploying Apollo graphql on netlify functions ",
  "code": "https://github.com/stubailo/apollo-netlify-lambda-app",
  "url": "https://blog.apollographql.com/deploy-a-fullstack-apollo-app-with-netlify-45a7dfd51b0b"
}

2. Regenerate the README.md with the following command

npm run docs

3. Open a new pull request with your example.