Skip to content

Commit

Permalink
[EDU -5393] Next.js e-commerce templates guide (#1308)
Browse files Browse the repository at this point in the history
* feat: create nextjs ecommerce templates guide

* feat: add entries to reference pages

* 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>
  • Loading branch information
guiafonso-ol and MarianaAguilera authored Oct 3, 2024
1 parent c3eed39 commit dfd6660
Show file tree
Hide file tree
Showing 6 changed files with 259 additions and 0 deletions.
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 @@ -76,6 +76,7 @@ permalink: /documentation/products/guides/
- [How to deploy an e-commerce based on Eleventy using a template](/en/documentation/products/guides/eleventy-ecommerce-collection/)
- [How to deploy an e-commerce based on Hugo using a template](/en/documentation/products/guides/hugo-ecommerce-collection/)
- [How to deploy an e-commerce based on Jekyll using a template](/en/documentation/products/guides/jekyll-ecommerce-collection/)
- [How to deploy an e-commerce based on Next.js using a template](/en/documentation/products/guides/next-js-ecommerce-collection/)
- [How to deploy and test HTMX on the edge with a template](/en/documentation/products/guides/htmx-boilerplate/)
- [How to deploy edge applications with the Angular Boilerplate](/en/documentation/products/guides/angular-boilerplate/)
- [How to deploy edge applications with the Astro Boilerplate](/en/documentation/products/guides/astro-boilerplate/)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
---
title: How to deploy an e-commerce based on Next.js using templates
description: >-
This guide contains instructions to create an e-commerce application using templates based on Next.js.
meta_tags: >-
Next.js, e-commerce, templates, guides, Azion Marketplace, deployment, online store
namespace: docs_guides_nextjs_ecommerce_templates_collection
permalink: /documentation/products/guides/next-js-ecommerce-collection/
---

import LinkButton from 'azion-webkit/linkbutton';
import Tag from 'primevue/tag';

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

The **Next.js E-commerce Templates** collection offers configurations for building e-commerce applications using templates. These templates are all based on the **Next.js** framework.

The available templates are:

- **Ecommerce Stationery NextJs**: create a stylish e-commerce based on Next.js. It uses versions `13.4.6` of Next.js and `18.2.0` of React.
- **Kupingplug**: accelerate the deployment of your e-commerce based on TailwindCSS and Next.js. It uses versions `14.0.3` of Next.js, `18` of React and `3.3.0` of TailwindCSS.
- **NextJs Store Ecommerce**: deploy a new e-commerce project using Next.js, React, and TailwindCSS. It uses versions `12.2.1` of Next.js, `18.2.0` of React, and `3.1.5` of TailwindCSS.
- **Simple Ecommerce Next.js**: build a shopping cart with Next.js and Stripe integration. It uses versions `13.1.6` of Next.js, `18.2.0` of React, and `3.2.6` of TailwindCSS.
- **Space Jelly Shop**: build a new e-commerce site with Next.js, React, and TypeScript. It uses versions `13.1.6` of Next.js, 18.2.0 of React, and `4.9.5` of TypeScript.

The deployment process for each of these templates creates a GitHub repository for your project, along with an edge application and a domain. This setup enables easy access and management of your e-commerce application through the Azion Edge Platform.

---

## 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.
- These templates use [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 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 templates through the Azion Console. To easily deploy any of them at the edge, click the respective button below.

<LinkButton
label="Deploy Ecommerce Stationery NextJs"
link="https://console.azion.com/create/azion-community/ecommerce-stationery-next"
icon="ai ai-azion"
icon-pos="left"
/>
<LinkButton
label="Deploy Kupingplug"
link="https://console.azion.com/create/azion-community/kupingplug"
icon="ai ai-azion"
icon-pos="left"
/>
<LinkButton
label="Deploy NextJs Store Ecommerce"
link="https://console.azion.com/create/azion-community/nextjs-store-ecommerce"
icon="ai ai-azion"
icon-pos="left"
/>
<LinkButton
label="Deploy Simple Ecommerce Next.js"
link="https://console.azion.com/create/azion-community/simple-ecommerce-next"
icon="ai ai-azion"
icon-pos="left"
/>
<LinkButton
label="Deploy Space Jelly Shop"
link="https://console.azion.com/create/azion-community/space-jelly-shop"
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.

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.

<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 @@ -350,6 +350,12 @@ The **Next.js App + Middleware** accelerates the deployment of a Next.js applica
icon-pos="left"
/>

#### Next.js E-commerce

The Next.js E-commerce Templates collection presents a number of templates for deploying an e-commerce application based on Next.js. You can choose and deploy the template that best fits your needs and preferences.

<LinkButton link="/en/documentation/products/guides/next-js-ecommerce-collection/" label="Go to the Next.js E-commerce Templates guide" severity="secondary" />

#### Next.js Pages + Configurations

The **Next.js Pages + Configurations** template enables you to quickly deploy a Next.js application with Pages Router and custom configurations.
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 @@ -108,6 +108,7 @@ permalink: /documentacao/produtos/guias/
- [Como implantar um e-commerce baseado no Eleventy usando um template](/pt-br/documentacao/produtos/guias/eleventy-ecommerce-collection/)
- [Como implantar um e-commerce baseado no Hugo usando um template](/pt-br/documentacao/produtos/guias/hugo-ecommerce-collection/)
- [Como implantar um e-commerce baseado no Jekyll usando um template](/pt-br/documentacao/produtos/guias/jekyll-ecommerce-collection/)
- [Como implantar um e-commerce baseado no Next.js usando um template](/pt-br/documentacao/produtos/guias/next-js-ecommerce-collection/)
- [Como integrar um banco de dados Turso com Azion usando um template](/pt-br/documentacao/produtos/guias/turso-starter-kit/)
- [Como testar o Bot Manager Lite usando um template](/pt-br/documentacao/produtos/guias/bot-manager-lite-starter-kit/)
- [Como migrar um site WordPress para o edge com WordPress EdgeAccelerator](/pt-br/documentacao/produtos/guias/wordpress-edgeaccelerator/)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
title: Como implantar um e-commerce baseado em Next.js usando templates
description: >-
Este guia contém instruções para criar uma aplicação e-commerce usando templates baseados em Next.js.
meta_tags: >-
Next.js, e-commerce, templates, guides, Azion Marketplace, deployment, online store
namespace: docs_guides_nextjs_ecommerce_templates_collection
permalink: /documentacao/produtos/guias/next-js-ecommerce-collection/
---

import LinkButton from 'azion-webkit/linkbutton';
import Tag from 'primevue/tag';

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

A coleção de **Templates de E-commerce Next.js** oferece configurações para construir aplicações de e-commerce usando templates. Esses templates são todos baseados no framework **Next.js**.

Os templates disponíveis são:

- **Ecommerce Stationery NextJs**: crie um e-commerce estiloso baseado em Next.js. Ele usa as versões `13.4.6` do Next.js e `18.2.0` do React.
- **Kupingplug**: acelere a implantação do seu e-commerce baseado em TailwindCSS e Next.js. Ele usa as versões `14.0.3` do Next.js, `18` do React e `3.3.0` do TailwindCSS.
- **NextJs Store Ecommerce**: implante um novo projeto de e-commerce usando Next.js, React e TailwindCSS. Ele usa as versões `12.2.1` do Next.js, `18.2.0` do React e `3.1.5` do TailwindCSS.
- **Simple Ecommerce Next.js**: construa um carrinho de compras com Next.js e integração com Stripe. Ele usa as versões `13.1.6` do Next.js, `18.2.0` do React e `3.2.6` do TailwindCSS.
- **Space Jelly Shop**: construa um novo site de e-commerce com Next.js, React e TypeScript. Ele usa as versões `13.1.6` do Next.js, `18.2.0` do React e `4.9.5` do TypeScript.

O processo de deploy para cada um desses templates cria um repositório GitHub para seu projeto, junto com uma aplicação edge e um domínio. Essa configuração permite fácil acesso e gerenciamento da sua aplicação de e-commerce através da Plataforma Azion Edge.

---

## 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.
- Estes templates usam [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/precos/) para mais informações.

---

## Implante o template

Você pode obter e configurar seus templates através do Azion Console. Para implantar um deles facilmente no edge, clique no respectivo botão abaixo.

<LinkButton
label="Implantar Ecommerce Stationery NextJs"
link="https://console.azion.com/create/azion-community/ecommerce-stationery-next"
icon="ai ai-azion"
icon-pos="left"
/>
<LinkButton
label="Implantar Kupingplug"
link="https://console.azion.com/create/azion-community/kupingplug"
icon="ai ai-azion"
icon-pos="left"
/>
<LinkButton
label="Implantar NextJs Store Ecommerce"
link="https://console.azion.com/create/azion-community/nextjs-store-ecommerce"
icon="ai ai-azion"
icon-pos="left"
/>
<LinkButton
label="Implantar Simple Ecommerce Next.js"
link="https://console.azion.com/create/azion-community/simple-ecommerce-next"
icon="ai ai-azion"
icon-pos="left"
/>
<LinkButton
label="Implantar Space Jelly Shop"
link="https://console.azion.com/create/azion-community/space-jelly-shop"
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.

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

<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 @@ -352,6 +352,12 @@ O template **Next.js App + Middleware** acelera a implantação de uma aplicaç
icon-pos="left"
/>

#### Next.js E-commerce

A coleção Next.js E-commerce Templates apresenta uma série de templates para implantar uma aplicação de e-commerce baseada em Next.js. Você pode escolher e implantar o template que melhor se adequa às suas necessidades e preferências.

<LinkButton link="/pt-br/documentacao/produtos/guias/next-js-ecommerce-collection/" label="Consulte o guia dos Next.js E-commerce Templates" severity="secondary" />

#### Next.js Pages + Configurations

O template **Next.js Pages + Configurations** permite implantar rapidamente uma aplicação Next.js com o Pages Router e configurações personalizadas.
Expand Down

0 comments on commit dfd6660

Please sign in to comment.