How to deploy edge applications with the Next.js Static Boilerplate

The Azion Next.js Static Boilerplate enables the creation and deployment of a Next.js Single-Page Application (SPA) directly on the edge of the network. By executing the boilerplate, several steps are automated, from repository management to edge deployment.

This template uses Next.js version 14.1.4.

About static exports

The core of Next.js supports static exports. This allows you to initiate your project either as a static site or a SPA and then add features that require a server. By using these advanced features, Next.js generates one HTML file per route, breaking a strict SPA into individual HTML files, and your project can be deployed and hosted on any web server that can serve HTML/CSS/JS static assets.

This capability includes supported and unsupported features, listed below, which you must take into account when developing and managing your project.

Go to Next.js documentation for more details on Static exports.

Supported features

  • Server components
  • Client components
  • Image optimization
  • Image optimization (through next/image can be used with a static export by defining a custom image loader in next.config.js)
  • Route handlers
  • Browser APIs

Unsupported features

These features require a Node.js server or dynamic logic that can’t be computed during the build process and aren’t supported:

  • Dynamic routes with dynamicParams: true
  • Dynamic routes without generateStaticParams()
  • Route handlers that rely on request
  • Cookies
  • Rewrites
  • Redirects
  • Headers
  • Middleware
  • Incremental static regeneration
  • Image optimization (with the default loader)
  • Draft mode

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.
  • Enable Edge Functions in your Azion account.
    • To do so:
  1. Access Console > Account menu.
  2. Select the Billing & Subscriptions option.
  3. Select the Subscriptions tab.
  4. Activate the switch for the module.

Getting the template

To start using the Next.js Static Boilerplate, access Azion Console and click the + Create button on the homepage.

This will open a modal where you can select Templates > Next.js Static Boilerplate card.

Setting up the template

In the configuration form, you must provide the information to configure your Angular 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.
  1. Select the Git Scope to work with.
  2. Define a name for your edge application.
  • The bucket for storage and the edge 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.
  1. 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.

Key configurations

The application undergoes an optimized build process, emphasizing optimal performance and efficiency, employing Azion Edge Platform resources.

The script creates a GitHub repository to manage the source code and then it installs all required dependencies. Besides that, your application is deployed on Azion’s platform and while carrying out multiple configurations, such as setting up the edge application and its domain to host your Next.js project and an edge function for custom logic.

The script also commits deployment details to the user’s GitHub repository to maintain a transparent and trackable deployment history, including information related to the version deployed and the timestamp of the deployment. The template also includes a GitHub Action to enable continuous deployment.

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

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

  1. Access 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.
  1. Find the edge application related to the Next.js Static Boilerplate 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.

Go to Domains reference

Watch the video guide on Next.js Static Boilerplate available on Azion’s YouTube channel:

Contributors