README.md

Gatsby

In this example we will be deploying a simple "Hello World" example with Gatsby.

Getting started with Gatsby

Start a new Gatsby project using:

npx gatsby new <project name>

Deploy with Now

First we need to create a now.json configuration file to instruct Now how to build the project.

For this example we will be using our newest version Now 2.0.

By adding the version key to the now.json file, we can specify which Now Platform version to use.

We also need to define each builders we would like to use. Builders are modules that take a deployment's source and return an output, consisting of either static files or dynamic Lambdas.

In this case we are going to use @now/static-build to build and deploy our Gatsby application selecting the package.json as our entry point. We will also define a name for our project (optional).

{
    "version": 2,
    "name": "gatsby",
    "builds": [
        { "src": "package.json", "use": "@now/static-build", "config": {"distDir": "public"} }
    ]
}

Visit our documentation for more information on the now.json configuration file.

We also need to include a script in package.json named "now-build" that specifies what command Now will run on the server to "build" your application. Also, notice that this builder accepts a configuration called "distDir", which should point to the output directory of our build script, which for Gatsby it is called public.

{
    "scripts": {
        ...
        "now-build": "npm run build"
    }
}

We are now ready to deploy the app.

now