Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EDU-5855] Stencil Boilerplate Guide #1402

Merged
merged 8 commits into from
Dec 24, 2024
1 change: 1 addition & 0 deletions src/content/docs/en/pages/guides/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ permalink: /documentation/products/guides/
- [How to deploy edge applications with the Hexo Boilerplate](/en/documentation/products/guides/hexo-boilerplate/)
- [How to deploy edge applications with the Next.js Static Boilerplate](/en/documentation/products/guides/nextjs-static-boilerplate/)
- [How to deploy edge applications with the React Boilerplate](/en/documentation/products/guides/react-boilerplate/)
- [How to deploy edge applications with the Stencil Boilerplate](/en/documentation/products/guides/stencil-boilerplate/)
- [How to deploy edge applications with the Svelte Boilerplate](/en/documentation/products/guides/svelte-boilerplate/)
- [How to deploy edge applications with the Vue Boilerplate](/en/documentation/products/guides/vue-boilerplate/)
- [How to deploy edge applications with the Vue3/Vite Boilerplate](/en/documentation/products/guides/vue-vite-boilerplate/)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: How to deploy edge applications with the Stencil Boilerplate
description: >-
The Stencil Boilerplate provides an automation solution to build a Stencil
guiafonso-ol marked this conversation as resolved.
Show resolved Hide resolved
application on Azion.
meta_tags: Stencil, templates, guides, Azion Marketplace
namespace: docs_guides_stencil_boilerplate
permalink: /documentation/products/guides/stencil-boilerplate/
---

import Tag from 'primevue/tag';

<Tag severity="info" client:only="vue">
Preview
</Tag>

With the **Stencil Boilerplate**, you can start a project using [Stencil](https://stenciljs.com/docs/introduction) and deploy it at the edge. **Stencil** is a compiler that generates Web Components and combines the best concepts of the most popular frameworks into a simple build-time tool.

The deployment of this template 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.

This template uses Stencil version `4.22.2`.

---

## Requirements

- A [GitHub account](https://github.com/signup) 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](/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](/en/documentation/products/build/edge-application/edge-functions/), and [Edge Cache](https://www.azion.com/en/documentation/products/build/edge-application/edge-cache/), and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.
guiafonso-ol marked this conversation as resolved.
Show resolved Hide resolved

---

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

<LinkButton
label="Deploy"
link="https://console.azion.com/create/stencil-boilerplate"
icon="ai ai-azion"
icon-pos="left"
/>

---

## Setting up the template

In the configuration form, you must provide the information to configure your application. Fill in the presented fields.
guiafonso-ol marked this conversation as resolved.
Show resolved Hide resolved

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](/en/documentation/products/guides/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 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.
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.

:::note
The link to the edge application allows you to see it on the browser. However, it takes a certain time to propagate and configure the application in Azion's edge locations. 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 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](https://console.azion.com).
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.

:::tip
Read the documentation about [managing edge applications](/en/documentation/products/build/edge-application/first-steps/) for more details.
:::

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

import LinkButton from 'azion-webkit/linkbutton';

<LinkButton link="/en/documentation/products/guides/configure-a-domain/" label="Go to configuring a domain guide" severity="secondary" />
Original file line number Diff line number Diff line change
Expand Up @@ -486,6 +486,18 @@ The **Svelte Boilerplate** streamlines the deployment of a static application ba
icon-pos="left"
/>

#### Stencil Boilerplate

The **Stencil Boilerplate** provides a solution to quickly set up a static web application using Stencil.

<LinkButton link="/en/documentation/products/guides/stencil-boilerplate/" label="Go to the Stencil Boilerplate guide" severity="secondary" />

<LinkButton
label="Deploy"
link="https://console.azion.com/create/stencil-boilerplate"
icon="ai ai-azion"
icon-pos="left"
/>

#### TiDB Starter Kit with Drizzle ORM

Expand Down
1 change: 1 addition & 0 deletions src/content/docs/pt-br/pages/guias/guides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ permalink: /documentacao/produtos/guias/
- [Como criar edge applications com o Hexo Boilerplate](/pt-br/documentacao/produtos/guias/hexo-boilerplate/)
- [Como criar edge applications com o Next.js Static Boilerplate](/pt-br/documentacao/produtos/guias/nextjs-static-boilerplate/)
- [Como criar edge applications com o React Boilerplate](/pt-br/documentacao/produtos/guias/react-boilerplate/)
- [Como criar edge applications com o Stencil Boilerplate](/pt-br/documentacao/produtos/guias/stencil-boilerplate/)
- [Como criar edge applications com o Svelte Boilerplate](/pt-br/documentacao/produtos/guias/svelte-boilerplate/)
- [Como criar edge applications com o Vue Boilerplate](/pt-br/documentacao/produtos/guias/vue-boilerplate/)
- [Como criar edge applications com o Vue3/Vite Boilerplate](/pt-br/documentacao/produtos/guias/vue-vite-boilerplate/)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: Como criar edge applications com o Stencil Boilerplate
description: >-
O Stencil Boilerplate fornece uma solução de automação para criar uma edge
application Stencil na Azion.
meta_tags: Stencil, templates, guides, Azion Marketplace
namespace: docs_guides_stencil_boilerplate
permalink: /documentacao/produtos/guias/stencil-boilerplate/
---

import Tag from 'primevue/tag';

<Tag severity="info" client:only="vue">
Preview
</Tag>

Com o **Stencil Boilerplate**, você pode iniciar um projeto usando [Stencil](https://stenciljs.com/docs/introduction) e implantá-lo no edge. **Stencil** é um compilador que gera Web Components e combina os melhores conceitos dos frameworks mais populares em uma ferramenta simples de compilação.
guiafonso-ol marked this conversation as resolved.
Show resolved Hide resolved

A implantação deste template cria um repositório no GitHub contendo seu projeto, bem como uma edge application e um domínio para facilitar seu acesso e gerenciamento através da Plataforma de Edge da Azion.

Este template utiliza a versão `4.22.2` do Stencil.

---

## Pré-requisitos

- Uma [conta GitHub](https://github.com/signup) para se conectar com a Azion e criar seu novo repositório.
- Cada push será implantado automaticamente nesse repositório para manter seu projeto atualizado.
- O template usa [Edge Functions](/pt-br/documentacao/produtos/build/edge-application/edge-functions/), [Application Accelerator](/pt-br/documentacao/produtos/build/edge-application/application-accelerator/), e [Edge Cache](/pt-br/documentacao/produtos/build/edge-application/edge-cache/). Isso pode gerar custos relacionados ao uso. Consulte a [página de preços](/pt-br/documentacao/produtos/precos/) para mais informações.
guiafonso-ol marked this conversation as resolved.
Show resolved Hide resolved

---

## Implante o template

Você pode obter e configurar seu template através do Azion Console. Para implantar facilmente no edge, clique no botão abaixo.

<LinkButton
label="Implantar"
link="https://console.azion.com/create/stencil-boilerplate"
icon="ai ai-azion"
icon-pos="left"
/>

---

## Configure o template

No formulário de configuração, você deve fornecer as informações para configurar sua aplicação. Preencha os campos apresentados.
guiafonso-ol marked this conversation as resolved.
Show resolved Hide resolved

Os campos identificados com um asterisco são obrigatórios.

1. Conecte a Azion com sua conta do GitHub.
- Uma janela pop-up será aberta para confirmar a instalação do [Azion GitHub App](/pt-br/documentacao/produtos/guias/azion-github-app/), uma ferramenta que conecta sua conta do GitHub com a plataforma da Azion.
- Defina suas permissões e acesso ao repositório como desejado.
2. Selecione o **Git Scope** com o qual trabalhar.
3. Defina um nome para sua edge application.
- O bucket para armazenamento e a edge function usarão o mesmo nome.
- Use um nome único e fácil de lembrar. Se o nome já tiver sido usado, a plataforma retornará uma mensagem de erro.
4. Clique no botão **Deploy** para iniciar o processo de implantação.

Durante a implantação, você poderá acompanhar o processo através de uma janela que mostra os logs. Quando estiver completo, a página mostra informações sobre a aplicação e algumas opções para continuar sua jornada.

:::note
O link para a edge application permite que você a veja no navegador. No entanto, leva um certo tempo para propagar e configurar a aplicação nas edge locations da Azion. Pode ser necessário esperar alguns minutos para que a URL seja ativada e para que a página da aplicação seja efetivamente exibida no navegador.
:::

---

## Gerencie o template

Considerando que essa configuração inicial pode não ser ótima para sua edge application específica, todas as configurações podem ser personalizadas a qualquer momento que você precisar, usando a plataforma da Azion.

Para gerenciar e editar as configurações da sua aplicação edge, siga esses passos:
guiafonso-ol marked this conversation as resolved.
Show resolved Hide resolved

1. [Acesse o Azion Console](https://console.azion.com).
2. No canto superior esquerdo, selecione **Products Menu**, o ícone de três linhas horizontais, > **Edge Application**.
- Você será redirecionado para a página **Edge Application**. Ela lista todas as edge application que você criou.
guiafonso-ol marked this conversation as resolved.
Show resolved Hide resolved
3. Encontre a edge application relacionada ao seu template e selecione-a.
- A lista está organizada alfabeticamente. Você também pode usar a **barra de busca** localizada no canto superior esquerdo da lista; atualmente, ela filtra apenas pelo campo **Application Name**.

Depois de selecionar a aplicação edge que você trabalhará, você será direcionado para uma página contendo todas as configurações que você pode configurar.
guiafonso-ol marked this conversation as resolved.
Show resolved Hide resolved

:::tip
Leia a documentação sobre [gerenciamento de edge application](/pt-br/documentacao/produtos/build/edge-application/primeiros-passos/) para mais detalhes.
:::

### Adicione um domínio personalizado

A edge application criada durante a implantação tem um domínio Azion atribuído para torná-la acessível através do navegador. O domínio tem o seguinte formato: `xxxxxxxxxx.map.azionedge.net/`. No entanto, você pode adicionar um domínio personalizado para que os usuários acessem sua edge application através dele.

import LinkButton from 'azion-webkit/linkbutton';

<LinkButton link="/pt-br/documentacao/produtos/guias/configurar-dominio/" label="Ir para o guia de configuração de domínio" severity="secondary" />
Original file line number Diff line number Diff line change
Expand Up @@ -488,6 +488,19 @@ O **Svelte Boilerplate** simplifica a implantação de uma aplicação estática
icon-pos="left"
/>

#### Stencil Boilerplate

O **Stencil Boilerplate** fornece uma solução para configurar rapidamente uma aplicação web estática usando Stencil.

<LinkButton link="/pt-br/documentacao/produtos/guias/stencil-boilerplate/" label="Consulte o guia do Stencil Boilerplate" severity="secondary" />

<LinkButton
label="Implantar"
link="https://console.azion.com/create/stencil-boilerplate"
icon="ai ai-azion"
icon-pos="left"
/>

#### TiDB Starter Kit with Drizzle ORM

Crie uma aplicação conectada a um banco de dados TiDB via Drizzle ORM.
Expand Down