Site React

Este gerador cria um novo website React com CloudScape configurado, juntamente com a infraestrutura AWS CDK ou Terraform para implantar seu website na nuvem como um site estático hospedado no S3, servido pelo CloudFront e protegido pelo WAF.

A aplicação gerada utiliza Vite como ferramenta de build e bundler. Usa TanStack Router para roteamento type-safe.

Nota

Embora este gerador configure o CloudScape, ele é fundamentalmente um gerador de projetos React, e você pode modificar seu código para migrar para um sistema de design ou biblioteca de componentes alternativo se desejar.

Utilização

Gerar um Website React

Você pode gerar um novo Website React de duas formas:

VSCode

1. Instale o Nx Console VSCode Plugin se ainda não o fez
2. Abra o console Nx no VSCode
3. Clique em Generate (UI) na seção "Common Nx Commands"
4. Procure por @aws/nx-plugin - ts#react-website
5. Preencha os parâmetros obrigatórios
6. Clique em Generate

CLI

pnpm

pnpm nx g @aws/nx-plugin:ts#react-website

yarn

yarn nx g @aws/nx-plugin:ts#react-website

npm

npx nx g @aws/nx-plugin:ts#react-website

bun

bunx nx g @aws/nx-plugin:ts#react-website

Você também pode realizar uma execução simulada para ver quais arquivos seriam alterados

pnpm

pnpm nx g @aws/nx-plugin:ts#react-website --dry-run

yarn

yarn nx g @aws/nx-plugin:ts#react-website --dry-run

npm

npx nx g @aws/nx-plugin:ts#react-website --dry-run

bun

bunx nx g @aws/nx-plugin:ts#react-website --dry-run

Opções

Parâmetro	Tipo	Padrão	Descrição
name Obrigatório	string	-	The name of the application.
directory	string	packages	The directory of the new application.
enableTailwind	boolean	true	Enable TailwindCSS for utility-first styling.
enableTanstackRouter	boolean	true	Enable Tanstack router for type-safe routing.
iacProvider	string	Inherit	The preferred IaC provider. By default this is inherited from your initial selection.

Saída do Gerador

O gerador criará a seguinte estrutura de projeto no diretório <directory>/<name>:

• index.html Ponto de entrada HTML
• public Assets estáticos
• Directorysrc

  • main.tsx Ponto de entrada da aplicação com configuração React
  • config.ts Configuração da aplicação (ex: logo)
  • Directorycomponents

    • AppLayout Componentes para o layout CloudScape e barra de navegação
  • Directoryhooks

    • useAppLayout.tsx Hook para ajustar o AppLayout de componentes aninhados
  • Directoryroutes

    • Directorywelcome

      • index.tsx Rota de exemplo (ou página) para @tanstack/react-router
  • styles.css Estilos globais
• vite.config.ts Configuração do Vite e Vitest
• tsconfig.json Configuração TypeScript base para código e testes
• tsconfig.app.json Configuração TypeScript para código fonte
• tsconfig.spec.json Configuração TypeScript para testes

Infraestrutura

Como este gerador fornece infraestrutura como código com base no iacProvider escolhido, ele criará um projeto em packages/common que inclui os constructs CDK ou módulos Terraform relevantes.

O projeto comum de infraestrutura como código está estruturado da seguinte forma:

CDK

• Directorypackages/common/constructs

  • Directorysrc

    • Directoryapp/ Constructs para infraestrutura específica de um projeto/gerador

      • …
    • Directorycore/ Constructs genéricos reutilizados pelos constructs em app

      • …
    • index.ts Ponto de entrada exportando os constructs de app
  • project.json Metas de build e configuração do projeto

Nota

Este projeto é gerado usando o gerador ts#project e portanto configura as mesmas metas de build.

Terraform

• Directorypackages/common/terraform

  • Directorysrc

    • Directoryapp/ Módulos Terraform para infraestrutura específica de um projeto/gerador

      • …
    • Directorycore/ Módulos genéricos reutilizados pelos módulos em app

      • …
  • project.json Metas de build e configuração do projeto

Nota

Este projeto é gerado usando o gerador terraform#project e portanto configura as mesmas metas de build.

O gerador cria infraestrutura como código para implantar seu website baseado no iacProvider selecionado:

CDK

• Directorypackages/common/constructs/src

  • Directoryapp

    • Directorystatic-websites

      • <name>.ts Infraestrutura específica para seu website
  • Directorycore

    • static-website.ts Construct genérico StaticWebsite

Terraform

• Directorypackages/common/terraform/src

  • Directoryapp

    • Directorystatic-websites

      • Directory<name>

        • <name>.tf Módulo específico para seu website
  • Directorycore

    • Directorystatic-website

      • static-website.tf Módulo genérico de website estático

Implementando seu Website React

A documentação do React é um bom ponto de partida para aprender os fundamentos de desenvolvimento com React. Você pode consultar a documentação do CloudScape para detalhes sobre os componentes disponíveis e como usá-los.

Rotas

Criando uma Rota/Página

Seu website CloudScape vem com TanStack Router configurado por padrão. Isso facilita a adição de novas rotas:

1. Execute o Servidor de Desenvolvimento Local
2. Crie um novo arquivo <page-name>.tsx em src/routes, com sua posição na estrutura de arquivos representando o caminho
3. Observe que um Route e RouteComponent são gerados automaticamente. Comece a construir sua página aqui!

Navegação Entre Páginas

Você pode usar o componente Link ou o hook useNavigate para navegar entre páginas:

import { Link, useNavigate } from '@tanstack/react-router';

export const MyComponent = () => {
  const navigate = useNavigate();

  const submit = async () => {
    const id = await ...
    // Use `navigate` para redirecionar após ação assíncrona
    navigate({ to: '/products/$id', { params: { id }} });
  };

  return (
    <>
      <Link to="/products">Cancelar</Link>
      <Button onClick={submit}>Enviar</Button>
    </>
  )
};

Para mais detalhes, consulte a documentação do TanStack Router.

Configuração de Runtime

A configuração de sua infraestrutura é fornecida ao seu website via Configuração de Runtime. Isso permite que seu website acesse detalhes como URLs de API que só são conhecidos após a implantação.

Infraestrutura

CDK

O construct CDK RuntimeConfig pode ser usado para adicionar e recuperar configuração em sua infraestrutura CDK. Os constructs CDK gerados pelos geradores @aws/nx-plugin (como ts#trpc-api e py#fast-api) adicionarão automaticamente valores apropriados ao RuntimeConfig.

Seu construct CDK do website implantará a configuração de runtime como um arquivo runtime-config.json na raiz do seu bucket S3.

packages/infra/src/stacks/application-stack.ts

import { Stack } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { MyWebsite } from ':my-scope/common-constructs';

export class ApplicationStack extends Stack {
  constructor(scope: Construct, id: string) {
    super(scope, id);

    // Adiciona automaticamente valores ao RuntimeConfig
    new MyApi(this, 'MyApi', {
      integrations: MyApi.defaultIntegrations(this).build(),
    });

    // Implanta automaticamente a config de runtime em runtime-config.json
    new MyWebsite(this, 'MyWebsite');
  }
}

Cuidado

Você deve garantir que declare seu website após quaisquer constructs que adicionem ao RuntimeConfig, caso contrário eles estarão faltando no arquivo runtime-config.json.

Terraform

Com Terraform, a configuração de runtime é gerenciada através dos módulos runtime-config. Os módulos Terraform gerados pelos geradores @aws/nx-plugin (como ts#trpc-api e py#fast-api) adicionarão automaticamente valores apropriados à configuração de runtime.

Seu módulo Terraform do website implantará a configuração de runtime como um arquivo runtime-config.json na raiz do seu bucket S3.

packages/infra/src/main.tf

# Adiciona automaticamente valores à config de runtime
module "my_api" {
  source = "../../common/terraform/src/app/apis/my-api"
}

# Implanta automaticamente a config de runtime em runtime-config.json
module "my_website" {
  source = "../../common/terraform/src/app/static-websites/my-website"

  providers = {
    aws.us_east_1 = aws.us_east_1
  }

  # Garante que API é implantada primeiro para adicionar à config de runtime
  depends_on = [module.my_api]
}

Cuidado

Você deve garantir que declare seu módulo de website após quaisquer módulos que adicionem à configuração de runtime e configure o depends_on apropriado para garantir ordem, caso contrário eles estarão faltando no arquivo runtime-config.json.

Código do Website

Em seu website, você pode usar o hook useRuntimeConfig para recuperar valores da configuração de runtime:

import { useRuntimeConfig } from '../hooks/useRuntimeConfig';

const MyComponent = () => {
  const runtimeConfig = useRuntimeConfig();

  // Acesse valores da config de runtime aqui
  const apiUrl = runtimeConfig.apis.MyApi;
};

Config de Runtime Local

Ao executar o servidor de desenvolvimento local, você precisará de um arquivo runtime-config.json em seu diretório public para que seu website local conheça as URLs de backend, configuração de identidade, etc.

Seu projeto de website está configurado com um target load:runtime-config que você pode usar para baixar o arquivo runtime-config.json de uma aplicação implantada:

pnpm

pnpm nx run <my-website>:"load:runtime-config"

yarn

yarn nx run <my-website>:"load:runtime-config"

npm

npx nx run <my-website>:"load:runtime-config"

bun

bunx nx run <my-website>:"load:runtime-config"

Nota

CDK

Se você alterar o prefixo dos nomes de stage em src/main.ts de seu projeto de infraestrutura, precisará atualizar o target load:runtime-config no arquivo project.json de seu website.

Além disso, é importante notar que o target load:runtime-config assume que um único stage de sua aplicação está implantado no ambiente para o qual você tem credenciais AWS. Você precisará ajustar o comando se implantar múltiplos stages na mesma conta e região.

Terraform

Para projetos Terraform, o target load:runtime-config copia o arquivo runtime-config.json criado após seu último terraform apply local.

Servidor de Desenvolvimento Local

Você pode executar um servidor de desenvolvimento local usando os targets serve ou serve-local.

Target Serve

O target serve inicia um servidor de desenvolvimento local para seu website. Este target requer que você tenha implantado qualquer infraestrutura de suporte com a qual o website interage, e tenha carregado a configuração de runtime local.

Você pode executar este target com o seguinte comando:

pnpm

pnpm nx run <my-website>:serve

yarn

yarn nx run <my-website>:serve

npm

npx nx run <my-website>:serve

bun

bunx nx run <my-website>:serve

Este target é útil para trabalhar em alterações do website apontando para APIs “reais” implantadas e outras infraestruturas.

Target Serve Local

O target serve-local inicia um servidor de desenvolvimento local para seu website (com Vite MODE definido como serve-local), além de iniciar quaisquer servidores locais para APIs conectadas via gerador API Connection.

Quando seu servidor local é executado via este target, runtime-config.json é automaticamente sobrescrito para apontar para URLs de API locais.

Você pode executar este target com o seguinte comando:

pnpm

pnpm nx run <my-website>:serve-local

yarn

yarn nx run <my-website>:serve-local

npm

npx nx run <my-website>:serve-local

bun

bunx nx run <my-website>:serve-local

Este target é útil quando você está trabalhando simultaneamente no website e na API e deseja iterar rapidamente sem implantar infraestrutura.

Quando executado neste modo e nenhum runtime-config.json estiver presente, se você configurou Autenticação Cognito (via gerador CloudScape Website Auth), o login será ignorado e requisições para servidores locais não incluirão headers de autenticação.

Para habilitar login e autenticação no serve-local, implante sua infraestrutura e carregue a config de runtime.

Build

Você pode construir seu website usando o target build. Isso usa o Vite para criar um bundle de produção no diretório dist/packages/<my-website>/bundle, além de type-checking, compilação e linting.

pnpm

pnpm nx run <my-website>:build

yarn

yarn nx run <my-website>:build

npm

npx nx run <my-website>:build

bun

bunx nx run <my-website>:build

Testes

Testar seu website é similar a escrever testes em um projeto TypeScript padrão. Consulte o guia de projetos TypeScript para detalhes.

Para testes específicos de React, o React Testing Library já está instalado e disponível. Para detalhes de uso, consulte a documentação do React Testing Library.

Você pode executar seus testes usando o target test:

pnpm

pnpm nx run <my-website>:test

yarn

yarn nx run <my-website>:test

npm

npx nx run <my-website>:test

bun

bunx nx run <my-website>:test

Implantando Seu Website

O gerador de website React cria infraestrutura como código CDK ou Terraform baseado no iacProvider selecionado. Você pode usar isso para implantar seu website.

CDK

Para implantar seu website, recomendamos usar o gerador ts#infra para criar uma aplicação CDK.

Você pode usar o construct CDK gerado em packages/common/constructs para implantar seu website.

packages/infra/src/stacks/application-stack.ts

import { Stack } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { MyWebsite } from ':my-scope/common-constructs';

export class ApplicationStack extends Stack {
  constructor(scope: Construct, id: string) {
    super(scope, id);

    new MyWebsite(this, 'MyWebsite');
  }
}

Isso configura:

1. Um bucket S3 para hospedar arquivos estáticos do website
2. Distribuição CloudFront para entrega global de conteúdo
3. Web ACL WAF para proteção de segurança
4. Origin Access Control para acesso seguro ao S3
5. Implantação automática de arquivos do website e configuração de runtime

Terraform

Para implantar seu website, recomendamos usar o gerador terraform#project para criar um projeto Terraform.

Você pode usar o módulo Terraform gerado em packages/common/terraform para implantar seu website.

packages/infra/src/main.tf

# Implanta website
module "my_website" {
  source = "../../common/terraform/src/app/static-websites/my-website"

  providers = {
    aws.us_east_1 = aws.us_east_1
  }
}

Isso configura:

1. Um bucket S3 para hospedar arquivos estáticos do website
2. Distribuição CloudFront para entrega global de conteúdo
3. Web ACL WAF para proteção de segurança (implantado em us-east-1)
4. Origin Access Control para acesso seguro ao S3
5. Implantação automática de arquivos do website e configuração de runtime

Nota

O provider aws.us_east_1 é necessário para recursos CloudFront e WAF, que devem ser implantados na região us-east-1. Garanta que sua configuração Terraform inclua este provider:

packages/infra/src/providers.tf

provider "aws" {
  alias  = "us_east_1"
  region = "us-east-1"
}