How to build with Gatsby

Gatsby is listed on the Jamstack documentation as a static site generator, aligned to the Jamstack approach.

Learn more about Gatsby.

Requirements

Before getting started, you must have:

• An Azion platform account with Edge Functions enabled.
• The latest version of Azion CLI installed.
• Code editor.
• Access to the terminal.
• Node.js ≥ 18.

Initializing an Gatsby project on the edge

1. Initialize the project:

  azion init

2. Give your project a name, or press enter to accept the given suggestion:

? Your application's name:  (black-thor)

3. Choose the Gatsby preset:

? Choose a preset:  [Use arrows to move, type to filter]
  Angular
  Astro
  Docusaurus
  Eleventy
  Emscripten
> Gatsby
  Hexo
  Hono
  Hugo
  Javascript
  ...

4. Choose one of the available templates.

5. With the template fetched and configured, you can choose to start a local development server.

Do you want to start a local development server? (y/N)

The following steps are based on the answer you gave.

• If you chose to have a local development server running.
• If you chose not to have a local development server running.

Answering yes to local dev

1. Install the project dependencies. Input y when the interaction prompts:

  Do you want to install project dependencies? This may be required to start local development server (y/N)

Wait until the installation is complete.

Output:

Your Edge Application was built successfully
[Azion] [Server] › ✔  success   Function running on port 0.0.0.0:3333, url: http://localhost:3333

2. On the browser, go to http://localhost:3333/ and you can see your Gatsby project running.

Deploying the project

When your project is running locally, you’re still able to deploy it to the edge. To do so:

1. Stop the terminal execution with control + c.

2. Access the project folder:

cd [your-project-name]

3. Deploy the project:

azion deploy

4. Wait while the project is built and deployed to the Azion Edge Platform.

After the deployment is complete, you’ll receive a domain to access your Gatsby project on the Azion’s platform.

Wait a few minutes so the propagation takes place, and then access your application using the provided domain, which should be similar to https://xxxxxxx.map.azionedge.net.

Answering no to local dev

After indicating you don’t want to have a local server running, deploy the Gatsby project to the edge.

1. Enter y to the following interaction, indicating you want to deploy the project:

   Do you want to deploy your project? (y/N)

2. Install the project dependencies. Input y when the interaction prompts:

  Do you want to install project dependencies? This may be required to deploy your project (y/N)

3. Wait while the project is built and deployed to the Azion edge platform.

After the deployment is complete, you’ll receive a domain to access your Gatsby project on the Azion Platform.

Wait a few minutes so the propagation takes place, and then access your application using the provided domain, which should be similar to https://xxxxxxx.map.azionedge.net.