-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[EDU-5856] Stencil PWA Boilerplate guide (#1403)
* feat: create stencil pwa guide * feat: add entried to reference pages * fix: minor changes * Apply suggestions from code review * Apply suggestions from code review
- Loading branch information
1 parent
a398268
commit 9753df8
Showing
6 changed files
with
208 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
89 changes: 89 additions & 0 deletions
89
src/content/docs/en/pages/guides/marketplace/templates/stencil-pwa-boilerplate.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| --- | ||
| title: How to deploy the Stencil PWA Boilerplate | ||
| description: This template contains the configurations for deploying a Progressive Web Application (PWA) using Stencil. | ||
| meta_tags: templates, guides, Azion Marketplace, Stencil | ||
| namespace: docs_guides_stencil_pwa_boilerplate | ||
| permalink: /documentation/products/guides/stencil-pwa-boilerplate/ | ||
| --- | ||
|
|
||
| import Tag from 'primevue/tag'; | ||
|
|
||
| <Tag severity="info" client:only="vue"> | ||
| Preview | ||
| </Tag> | ||
|
|
||
| The **Stencil PWA Boilerplate** template contains the configurations to quickly build a [Stencil](https://stenciljs.com/docs/introduction) based [Ionic PWA](https://ionic.io/pwa) (Progressive Web Application), a toolchain for building fast, reusable UI components and static sites. | ||
|
|
||
| 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](/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. | ||
|
|
||
| --- | ||
|
|
||
| ## 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/stencil-pwa-boilerplate" | ||
| icon="ai ai-azion" | ||
| icon-pos="left" | ||
| /> | ||
|
|
||
| --- | ||
|
|
||
| ## Setting up the template | ||
|
|
||
| In the configuration form, you must provide the information to set up 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](/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" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
...ontent/docs/pt-br/pages/guias/marketplace/templates/stencil-pwa-boilerplate.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| --- | ||
| title: Como implantar o Stencil PWA Boilerplate | ||
| description: Este template contém as configurações para implantar uma Progressive Web Application (PWA) usando Stencil. | ||
| meta_tags: templates, guides, Azion Marketplace, web | ||
| namespace: docs_guides_stencil_pwa_boilerplate | ||
| permalink: /documentacao/produtos/guias/stencil-pwa-boilerplate/ | ||
| --- | ||
|
|
||
| import Tag from 'primevue/tag'; | ||
|
|
||
| <Tag severity="info" client:only="vue"> | ||
| Preview | ||
| </Tag> | ||
|
|
||
| O template **Stencil PWA Boilerplate** contém as configurações para construir rapidamente uma PWA (Progressive Web Application) com [Ionic](https://ionic.io/pwa) baseada em [Stencil](https://stenciljs.com/docs/introduction), uma ferramenta para criar componentes de UI e sites estáticos rápidos e reutilizáveis. | ||
|
|
||
| A implantação deste template cria um repositório do GitHub contendo seu projeto, além de uma edge application e um domínio para facilitar seu acesso e gerenciamento através da Plataforma de Edge da Azion. | ||
|
|
||
| Este template usa 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. | ||
|
|
||
| --- | ||
|
|
||
| ## Implante o template | ||
|
|
||
| Você pode obter e configurar seu template através do Azion Console. Para implantá-lo facilmente no edge, clique no botão abaixo. | ||
|
|
||
| <LinkButton | ||
| label="Implantar" | ||
| link="https://console.azion.com/create/stencil/stencil-pwa-boilerplate" | ||
| icon="ai ai-azion" | ||
| icon-pos="left" | ||
| /> | ||
|
|
||
| --- | ||
|
|
||
| ## Configure o template | ||
|
|
||
| No formulário de configuração, você deve fornecer as informações para personalizar sua aplicação. Preencha os campos apresentados. | ||
|
|
||
| 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ê precise, usando a plataforma da Azion. | ||
|
|
||
| Para gerenciar e editar as configurações da sua edge application, siga esses passos: | ||
|
|
||
| 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 applications que você criou. | ||
| 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 edge application que você trabalhará, você será direcionado para uma página contendo todas as configurações que você pode ajustar. | ||
|
|
||
| :::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" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters