Deploying with Netlify Functions

How to run your API using Netlify Functions on AWS Lambda

Netlify Functions allow deploying server-side code, directly from GitHub, to AWS Lambda. This guide demonstrates how to use Netlify Functions to deploy a GraphQL server and reference the server in Apollo Client. Some benefits of Netlify Functions include:

Use the same platform to deploy your frontend and API code.
Deploy previews of both your frontend and API on every pull request.
No need to worry about scaling containers due to a "serverless" infrastructure.

In the following sections, we'll set up a "Hello World" API and frontend for an Apollo app on Netlify. Let's get started!

Download and Run the Netlify Starter Kit

Download and run the official Netlify create-react-app and Lambda starter kit. This will set us up with a base for our frontend and API code.

1
git clone https://github.com/netlify/create-react-app-lambda.git
2
cd create-react-app-lambda
3
npm install

Let’s take a quick look at the file structure here:

package.json: This application's dependencies, shared between client and server code. You can also split them up into separate directories later, depending on your preference.
netlify.toml: The configuration for Netlify.
src/: The source code for the React frontend app.
src/lambda/: The server source code that will be deployed to Netlify Functions.

In package.json, you'll find scripts to run the frontend and lambda code:

1
"scripts": {
2
  "start": "react-scripts start",
3
  "start:lambda": "netlify-lambda serve src/lambda",
4
  "build": "react-scripts build",
5
  "build:lambda": "netlify-lambda build src/lambda",
6
}

Run the code to see that everything is working. We have to open two terminal windows to run the frontend and functions at the same time:

1
# In the first terminal, run the local development server.
2
# This emulates the Netlify Functions runtime environment.
3
npm run start:lambda
4
# In the second terminal, start the React frontend application.
5
npm start

If everything looks like it started correctly, let's add a GraphQL API with Apollo Server!

Set up Apollo Server

Netlify Functions run on AWS Lambda, so we can use the apollo-server-lambda package to easily integrate Apollo Server for our API layer. Let’s install the packages we need for that:

1
npm install --save apollo-server-lambda graphql

Now, we can create a "Hello world" GraphQL API. Let's put that in a new file in the lambda folder, at src/lambda/graphql.js:

1
// src/lambda/graphql.js
2
const { ApolloServer, gql } = require("apollo-server-lambda");
3

4
const typeDefs = gql`
5
  type Query {
6
    hello: String
7
  }
8
`;
9

10
const resolvers = {
11
  Query: {
12
    hello: (parent, args, context) => {
13
      return "Hello, world!";
14
    }
15
  }
16
};
17

18
const server = new ApolloServer({
19
  typeDefs,
20
  resolvers
21
});
22

23
exports.handler = server.createHandler();

Now, make sure you've run NODE_ENV=development npm run start:lambda, and navigate to localhost:9000/graphql in your browser. You should see GraphQL Playground, where you can run queries against your API!

Note - The GraphQL Playground will only run if your NODE_ENV is set to development. If you don't pass this, or your NODE_ENV is set to production, you will not see the GraphQL Playground.

If you can see GraphQL Playground and run a simple query, you've done everything properly. Now, let's add Apollo Client to the frontend.

Add endpoint to Apollo Client

The starter kit is set up so that requests that start with .netlify/functions are automatically redirected to the Lambda functions in our project. Since our API is defined with the filename graphql.js, we can call it with .netlify/functions/graphql from our frontend.

1
// src/App.js
2
import ApolloClient from "apollo-boost";
3
const client = new ApolloClient({
4
  uri: "/.netlify/functions/graphql"
5
});

For more information, take a look at the Getting Started Guide for React

Deploy to Netlify

Netlify can deploy automatically from a linked GitHub repository, so we'll use that technique for the rest of this tutorial which will allow each git push to automatically deploy. To enable this, first create a new, empty repository on GitHub.

To start the project, we cloned the Netlify starter kit. If we want the local repository to point to our new GitHub repo instead of the starter kit, we need to change the origin, like this:

1
# Replace the following URL with the appropriate URL obtained when
2
# creating the new GitHub repository in the previous step!
3
git remote set-url origin git@github.com:username/repository.git

Now, commit and push:

1
git add .
2
git commit -m "Add Apollo Server and Client"
3
git push -u origin # Specify your branch name, if necessary.

Check the repository to make sure the code showed up.

The starter kit came with a netlify.toml configuration file, so we don’t have to change any settings in the UI. Just continue to the deploy step right away.

Wait for it to deploy, and in the meanwhile you can set a custom name for your app. Once it’s done, you’re live!

The best part is, you don’t need to do anything special to scale this up. Since the frontend is running on Netlify’s CDN and the API is a serverless function on Lambda, you don’t have to worry about adding or removing servers.

Lambda

Azure Functions