How to deploy the VitePress JavaScript Boilerplate

VitePress JavaScript Boilerplate allows you to deploy a static project on the edge quickly and easily. VitePress, a static site generator built on top of Vite and Vue.js, is ideal for creating documentation websites with features including a markdown-based content system, a built-in theming system, and fast hot module replacement.

This template, written in JavaScript, creates a GitHub repository containing your project, as well as an edge application and a domain to facilitate your access and management through Azion Edge Platform.

VitePress JavaScript Boilerplate uses VitePress version 1.3.0.

Requirements

• A GitHub account to connect with Azion and create your new repository.
  • Every push will be deployed automatically to the main branch in this repository to keep your project updated.
• Enable Application Accelerator in your account.
  • To do so, go to the Billing & Subscriptions section and activate the switch for each module.
  • If this module isn’t activated, the execution will fail and a log explaining the reason will be printed.
  • If this module is activated, deploying this template could 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 at the edge, click the 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. Define a name for your edge application.

• The bucket for storage 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.

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 > 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.