How to deploy a web application based on ButterCMS using templates

The ButterCSM Templates collection offers configurations for making collaborative content management of your application easier.

These templates are all integrated with the ButterCMS.

The available templates are:

• ButterCMS + Gatsby Starter Project: create a fully-functional Gatsby starter project, integrated with ButterCMS. It uses version 5.7.0 of Gatsby.
• ButterCMS + Angular Starter Project: create a fully-functional Angular starter project, integrated with ButterCMS. It uses version 15.1.2. of Angular.
• ButterCMS + Nuxt Starter Project: create a fully-functional Nuxt starter project, integrated with ButterCMS. It uses version 3.2.3 of Nuxt.
• ButterCMS + React Starter Project: create a fully-functional React starter project, integrated with ButterCMS. It uses version 18.2.0 of React.
• ButterCMS + Vue.js Starter Project: create a fully-functional Vue.js starter project, integrated with ButterCMS. It uses version 3.2.45 of Vue.js.

The deployment process for each of these templates creates a GitHub repository for your project, along with an edge application and a domain. This setup enables easy access and management of your VuePress application through the Azion Edge Platform.

Requirements

• 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.
• Have a ButterCMS account.
• These templates use Application Accelerator, Edge Functions, and Edge Cache, and it could generate usage-related costs. Check the pricing page for more information.

Deploying the template

You can obtain and configure your templates through the Azion Console. To easily deploy any of them at the edge, click the respective button below.

Setting up the template

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

Fields identified with an asterisk are mandatory.

1. 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.
2. Select the Git Scope to work with.
3. Fill in the information to setup the application:
   • Application Name: define a unique name for your edge application.
   • ButterCMS API Key: the ButterCMS API access key required for the application to read content.
4. Click the Deploy button to start the deployment process.

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

Managing the template

Considering that this initial setup may not be optimal for your specific edge application, all settings can be customized any time you need by using Azion’s platform.

To manage and edit your edge application’s settings, follow these steps:

1. Access Azion Console.
2. On the upper-left corner, select Products menu, the icon with three horizontal lines, > Edge Application.
   • You’ll be redirected to the Edge Application page. It lists all the edge applications you’ve created.
3. Find the edge application related to your template and select it.
   • 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 edge application you’ll work on, you’ll be directed to a page containing all the settings you can configure.

Adding a custom domain

The edge application created during the deployment has an assigned Azion 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 edge application through it.