Arquétipo de projeto do AEM

O AEM Project Archetype é um modelo Maven que cria um projeto Adobe Experience Manager (AEM) mínimo, baseado em práticas recomendadas, como ponto de partida para seu site.

DICA

O Arquétipo de projeto AEM mais recente pode ser encontrado no GitHub.

Recursos

  • Documentação do arquétipo (este documento): visão geral da arquitetura do arquétipo e de seus diferentes módulos.
  • Os seguintes tutoriais são baseados nesse arquétipo:

Recursos

  • Prática recomendada: Bootstrap seu site com todas as práticas recomendadas mais recentes do Adobe.
  • Código baixo: edite seus modelos, crie conteúdo, implante seu CSS e seu site está pronto para entrar em funcionamento.
  • Pronto para nuvem: se desejar, use o AEM as a Cloud Service para entrar em funcionamento em alguns dias e facilitar a escalabilidade e a manutenção.
  • Dispatcher: um projeto é concluído somente com uma configuração do Dispatcher que garante a velocidade e a segurança.
  • Vários sites: se necessário, o arquétipo gera a estrutura de conteúdo para uma configuração de vários idiomas e de várias regiões.
  • Componentes principais: os autores podem criar quase qualquer layout com nosso conjunto versátil de componentes padronizados.
  • Modelos editáveis: monte praticamente qualquer modelo sem código e defina o que os autores têm permissão para editar.
  • Layout responsivo: em modelos ou páginas individuais, defina como os elementos fluem para os pontos de interrupção definidos.
  • Cabeçalho e rodapé: monta-os e os localiza sem código, usando os recursos de localização dos componentes.
  • Sistema de estilos: evite criar componentes personalizados permitindo que os autores apliquem estilos diferentes a eles.
  • Build de front-end: os desenvolvedores de front-end podem modelar páginas de AEM e criar bibliotecas de clientes com Webpack, TypeScript e SASS.
  • Pronto para WebApp-Ready: para sites que usam o 🔗 Reator Angular, use o SPA SDKpara manter a criação em contexto do aplicativo.
  • Ativado para comércio: para projetos que desejam integrar AEM Commerce com soluções comerciais, como 🔗 Magentousing the Commerce Core Components.
  • Exemplo de código: faça o check-out do componente HelloWorld e dos modelos de amostra, servlets, filtros e agendadores.
  • Fonte aberta: se algo não é como deveria, 🔗 contribua para as melhorias!

Uso

Para gerar um projeto, ajuste a seguinte linha de comando de acordo com suas necessidades:

mvn -B archetype:generate \
 -D archetypeGroupId=com.adobe.aem \
 -D archetypeArtifactId=aem-project-archetype \
 -D archetypeVersion=27 \
 -D appTitle="My Site" \
 -D appId="mysite" \
 -D groupId="com.mysite" \
  • Defina aemVersion=cloud para AEM como um Cloud Service;
    Defina aemVersion=6.5.0 para Adobe Managed Services, ou no local.
    A dependência dos Componentes principais é adicionada apenas para versões do aem que não estão na nuvem, pois os Componentes principais são fornecidos OTB para AEM como Cloud Service.
  • Ajuste appTitle="My Site" para definir o título do site e os grupos de componentes.
  • Ajuste appId="mysite" para definir o Maven artifactId, os nomes do componente, da configuração e da pasta de conteúdo, bem como os nomes da biblioteca do cliente.
  • Ajuste groupId="com.mysite" para definir o Maven groupId e o Pacote de Origem Java.
  • Pesquise a lista de propriedades disponíveis para ver se há mais itens que você deseja ajustar.

Propriedades disponíveis

Nome Padrão Descrição
appTitle O título do aplicativo será usado para o título do site e grupos de componentes (por exemplo, "My Site").
appId O nome técnico será usado para nomes de componentes, configurações e pastas de conteúdo, bem como para nomes de bibliotecas de clientes (por exemplo, "mysite").
artifactId ${appId} ID de artefato Maven de base (por exemplo, "mysite").
groupId ID de grupo Maven de base (por exemplo, "com.mysite").
package ${groupId} Pacote de origem Java (por exemplo, "com.mysite").
version 1.0-SNAPSHOT Versão do projeto (por exemplo, 1.0-SNAPSHOT).
aemVersion cloud Versão de AEM de destino (pode ser cloud para AEM como Cloud Service; ou 6.5.0, ou 6.4.4 para Adobe Managed Services ou no local).
sdkVersion latest Quando aemVersion=cloud uma versão SDK pode ser especificada (por exemplo, 2020.02.2265.20200217T222518Z-200130).
includeDispatcherConfig y Inclui uma configuração de dispatcher para nuvem ou para AMS/no local, dependendo do valor de aemVersion (pode ser y ou n).
frontendModule general Inclui um módulo de compilação de frontend do Webpack que gera as bibliotecas de clientes (pode ser general ou none para sites regulares; pode ser angular ou react para um Aplicativo de página única que implementa o Editor de SPA).
language en Código de idioma (ISO 639-1) para criar a estrutura de conteúdo de (por exemplo, en, deu).
country us Código do país (ISO 3166-1) para criar a estrutura de conteúdo de (por exemplo, US).
singleCountry y Inclui uma estrutura de conteúdo principal de idioma (pode ser y ou n).
includeExamples n Inclui um site de exemplo Biblioteca de componentes (pode ser y ou n).
includeErrorHandler n Inclui uma página de resposta 404 personalizada que será global para toda a instância (pode ser y ou n).
includeCommerce n Inclui Componentes principais da CIF dependências e gera artefatos correspondentes.
commerceEndpoint Necessário somente para CIF. Ponto de extremidade opcional do sistema de comércio do serviço GraphQL a ser usado (por exemplo, https://hostname.com/grapql).
datalayer y Ative a integração com Adobe Client Data Layer.
amp n Habilite o suporte AMP para modelos de projeto gerados.

Requisitos do sistema

Arquétipo AEM as a Cloud Service AEM 6.5 AEM 6.4 Java SE Maven
26º Contínuo 6.5.5.0+ 6.4.8.1+ 8, 11 3.3.9+

Configure seu ambiente de desenvolvimento local para AEM como um SDK do Cloud Service ou para versões mais antigas do AEM.

Problemas conhecidos

Ao executar no Windows e gerar a configuração do dispatcher, você deve estar executando um prompt de comando elevado ou o Subsistema do Windows para Linux (consulte #329).

Ao executar o arquétipo no modo interativo (sem o parâmetro -B ), as propriedades com valores padrão não podem ser alteradas, a menos que a confirmação final seja descartada, o que então repete as perguntas incluindo as propriedades com valores padrão nas perguntas (consulte
ARCHETYPE-308 para obter detalhes).

Leitura adicional

Para obter mais detalhes sobre o uso do arquétipo, incluindo seus benefícios, opções e como seus módulos funcionam, consulte o documento Usando o Arquétipo.

Nesta página