Deploy Apps with the Gatsby Boilerplate

The Gatsby Boilerplate helps you build a Single-Page Application (SPA) based on the Gatsby framework and run it directly on Azion’s distributed infrastructure. By executing the boilerplate, several steps are encapsulated and automated, from repository management to deployment.

This template deploys an application, a domain, and a related GitHub repository to facilitate your access and management. It also contains a GitHub Action to enable a continuous integration workflow and keep your application and repository up to date.

The Gatsby Boilerplate uses Gatsby version 5.13.3 and React version 18.2.0.

Requirements

To use this template, you must:

Have a GitHub account to connect with Azion and create your new repository.
- Every push will be deployed automatically to this repository to keep your project updated.
This template uses Application Accelerator, and it may generate usage-related costs. Check the pricing page for more information.

Deploying the template

You can obtain and configure your template through the Azion Console. To easily deploy it on Azion, select the button below.

Deploy

Setting up the template

In the configuration form, you must provide the information to configure your new application. Fill in the presented fields.

Fields identified with an asterisk are mandatory.

Connect Azion with your GitHub account

A pop-up window will open to confirm the installation of the Azion GitHub App, a tool that connects your GitHub account with Azion’s platform.
Define your permissions and repository access as desired.

Select the Git Scope

Select the Git Scope to work with.

Define a name for your application

The bucket for storage and the function will use the same name.
Use a unique and easy-to-remember name. If the name has already been used, the platform returns an error message.

Select Deploy

Select the Deploy button to start the deployment process.

During the deployment, you’ll be able to follow the process through a window showing the logs. When it’s complete, the page shows information about the application and some options to continue your journey.

The link to the application allows you to see it on the browser. However, it takes a certain time to propagate and configure the application on Azion’s distributed infrastructure. It may be necessary to wait a few minutes for the URL to be activated and for the application page to be effectively displayed in the browser.

Managing the template

Considering that this initial setup may not be optimal for your specific application, all settings can be customized any time you need through Azion Console.

To manage and edit your application’s settings, proceed as follows:

Access Applications

Access Azion Console > Applications.

You’ll be redirected to the Applications page. It lists all the applications you’ve created.

Select your application

Select the application related to this template.

The list is organized alphabetically. You can also use the search bar located in the upper-left corner of the list; currently, it filters only by Application Name.

After selecting the application you’ll work on, you’ll be directed to a page containing all the settings you can configure.

Read the documentation about managing applications for more details.

Adding a custom domain

The application created during the deployment has an assigned Azion Workload domain to make it accessible through the browser. The domain has the following format: xxxxxxxxxx.map.azionedge.net/. However, you can add a custom domain for users to access your application through it.

For more information, refer to Add a custom domain to a workload.