From 278cd892b2b2dd021d5f87cf6a27b472b76255d5 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Oliveira Date: Tue, 29 Oct 2024 15:09:27 -0300 Subject: [PATCH] [EDU-5296] Neon Database with Drizzle template guide (#1334) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: add drizzle + neon guide * fix: change file name * fix: adjust template name and description * feat: add entries in reference pages * fix: minor adjustments * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Mariana Bellorín Aguilera <89138244+MarianaAguilera@users.noreply.github.com> --------- Co-authored-by: Mariana Bellorín Aguilera <89138244+MarianaAguilera@users.noreply.github.com> --- src/content/docs/en/pages/guides/index.mdx | 1 + .../templates/neon-database-with-drizzle.mdx | 91 +++++++++++++++++++ .../understand-azion-templates.mdx | 13 +++ src/content/docs/pt-br/pages/guias/guides.mdx | 1 + .../templates/neon-databse-with-drizzle.mdx | 91 +++++++++++++++++++ .../templates-visao-geral.mdx | 13 +++ 6 files changed, 210 insertions(+) create mode 100644 src/content/docs/en/pages/guides/marketplace/templates/neon-database-with-drizzle.mdx create mode 100644 src/content/docs/pt-br/pages/guias/marketplace/templates/neon-databse-with-drizzle.mdx diff --git a/src/content/docs/en/pages/guides/index.mdx b/src/content/docs/en/pages/guides/index.mdx index e3530caf01..9440538214 100644 --- a/src/content/docs/en/pages/guides/index.mdx +++ b/src/content/docs/en/pages/guides/index.mdx @@ -102,6 +102,7 @@ permalink: /documentation/products/guides/ - [How to deploy the Image Optimization template](/en/documentation/products/guides/image-optimization-template/) - [How to deploy the Jekyll Boilerplate](/en/documentation/products/guides/jekyll-boilerplate/) - [How to deploy the MongoDB Atlas Boilerplate](/en/documentation/products/guides/mongodb-atlas/) +- [How to deploy the Neon Database Starter Kit with Drizzle ORM template](/en/documentation/products/guides/neon-database-with-drizzle/) - [How to deploy the Next.js App + Configurations template](/en/documentation/products/guides/nextjs-app-configurations/) - [How to deploy the Next.js App + Middleware template](/en/documentation/products/guides/nextjs-app-middleware/) - [How to deploy the Next.js Pages + Configurations template](/en/documentation/products/guides/nextjs-pages-configurations/) diff --git a/src/content/docs/en/pages/guides/marketplace/templates/neon-database-with-drizzle.mdx b/src/content/docs/en/pages/guides/marketplace/templates/neon-database-with-drizzle.mdx new file mode 100644 index 0000000000..d1e149c2a2 --- /dev/null +++ b/src/content/docs/en/pages/guides/marketplace/templates/neon-database-with-drizzle.mdx @@ -0,0 +1,91 @@ +--- +title: How to deploy the Neon Database Starter Kit with Drizzle ORM template +description: This template contains the configurations to build and connect an application to Neon Database. +meta_tags: Drizzle ORM, Neon Database, Edge Functions, Azion Marketplace, web, guides, templates +namespace: docs_guides_neon_database_with_drizzle +permalink: /documentation/products/guides/neon-database-with-drizzle/ +--- + +import Tag from 'primevue/tag'; + + +Preview + + +The **Neon Database Starter Kit with Drizzle ORM** template contains the configurations for creating and connecting an edge application to a Neon database via Drizzle ORM. + +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. It also creates a new table in your Neon database. + +--- + +## 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. +- A [Neon database](https://neon.tech/) with available space for a new table. + +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. Database storage and operations could also generate costs directly by Neon. Check [Neon's pricing page](https://neon.tech/pricing) for details. + +--- + +## 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](/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. Fill in the information to setup the application: + - **Application Name**: define a unique name for your edge application, which will be the same for the storage bucket and the edge function. + - **Neon Database Connection URL**: postgres connection URL to your Neon Database. +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'; + + diff --git a/src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx b/src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx index 94e3349e7a..8e4ad762d7 100644 --- a/src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx +++ b/src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx @@ -337,6 +337,19 @@ The Jekyll E-commerce Templates collection presents a number of templates for de +#### Neon Database Starter Kit with Drizzle ORM + +Create an application connected to a Neon Database via Drizzle ORM. + + + + + #### Next.js App + Configurations The **Next.js App + Configurations** template provides a quick start to build a Next.js application with custom configurations and App Router to run it directly on the edge. diff --git a/src/content/docs/pt-br/pages/guias/guides.mdx b/src/content/docs/pt-br/pages/guias/guides.mdx index da8a3235ad..2145f18788 100644 --- a/src/content/docs/pt-br/pages/guias/guides.mdx +++ b/src/content/docs/pt-br/pages/guias/guides.mdx @@ -98,6 +98,7 @@ permalink: /documentacao/produtos/guias/ - [Como implantar o template Gatsby E-commerce Theme](/pt-br/documentacao/produtos/guias/gatsby-ecommerce-theme/) - [Como implantar o template Hello World](/pt-br/documentacao/produtos/guias/hello-world-template/) - [Como implantar o template Image Optimization](/pt-br/documentacao/produtos/guias/image-optimization-template/) +- [Como implantar o template Neon Database Starter Kit with Drizzle ORM](/pt-br/documentacao/produtos/guias/neon-database-with-drizzle/) - [Como implantar o template Static Cache](/pt-br/documentacao/produtos/guias/static-cache-template/) - [Como implantar o template Upstash Rate Limiting](/pt-br/documentacao/produtos/guias/upstash-rate-limiting/) - [Como implantar o template Webpage to PDF Resume](/pt-br/documentacao/produtos/guias/webpage-to-pdf-resume/) diff --git a/src/content/docs/pt-br/pages/guias/marketplace/templates/neon-databse-with-drizzle.mdx b/src/content/docs/pt-br/pages/guias/marketplace/templates/neon-databse-with-drizzle.mdx new file mode 100644 index 0000000000..ff635d5aba --- /dev/null +++ b/src/content/docs/pt-br/pages/guias/marketplace/templates/neon-databse-with-drizzle.mdx @@ -0,0 +1,91 @@ +--- +title: Como implantar o template Neon Database Starter Kit with Drizzle ORM +description: Este template contém as configurações para construir e conectar uma aplicação ao Neon Database. +meta_tags: Drizzle ORM, Neon Database, Edge Functions, Azion Marketplace, web, guides, templates +namespace: docs_guides_neon_database_with_drizzle +permalink: /documentacao/produtos/guias/neon-database-with-drizzle/ +--- + +import Tag from 'primevue/tag'; + + +Preview + + +O template **Neon Database Starter Kit with Drizzle ORM** contém as configurações para criar e conectar uma edge application a um banco de dados Neon via Drizzle ORM. + +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. Além disso, cria uma nova tabela no seu banco de dados Neon. + +--- + +## 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. +- Um [banco de dados Neon](https://neon.tech/) com espaço disponível para uma nova tabela. + +Este template usa [Application Accelerator](/pt-br/documentacao/produtos/build/edge-application/application-accelerator/), [Edge Functions](/pt-br/documentacao/produtos/build/edge-application/edge-functions/) 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. O armazenamento e as operações do banco de dados também podem gerar custos diretamente na Neon. Verifique a [página de preços da Neon](https://neon.tech/pricing) para obter detalhes. + +--- + +## 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. + + + +--- + +## Configure o template + +No formulário de configuração, você deve fornecer as informações para configurar 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. Preencha as informações para configurar a aplicação: + - **Application Name**: defina um nome único para sua edge application, que será o mesmo para o bucket de armazenamento e a edge function. + - **Neon Database Connection URL**: URL de conexão postgres para o seu banco de dados Neon. +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 aplicação edge, 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 application 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 aplicação edge que você trabalhará, você será direcionado para uma página contendo todas as configurações que você pode configurar. + +:::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'; + + diff --git a/src/content/docs/pt-br/pages/menu-principal/recursos-adicionais/templates-e-integracoes/templates-visao-geral.mdx b/src/content/docs/pt-br/pages/menu-principal/recursos-adicionais/templates-e-integracoes/templates-visao-geral.mdx index f6c6308f16..6147b6c639 100644 --- a/src/content/docs/pt-br/pages/menu-principal/recursos-adicionais/templates-e-integracoes/templates-visao-geral.mdx +++ b/src/content/docs/pt-br/pages/menu-principal/recursos-adicionais/templates-e-integracoes/templates-visao-geral.mdx @@ -339,6 +339,19 @@ A coleção Jekyll E-commerce Templates apresenta uma série de templates para i +#### Neon Database Starter Kit with Drizzle ORM + +Crie uma aplicação conectada a um banco de dados Neon via Drizzle ORM. + + + + + #### Next.js App + Configurations O template **Next.js App + Configurations** agiliza a criação de uma aplicação Next.js com configurações personalizadas e App Router para executá-la diretamente no edge.