AEM Project Archetype aem-project-archetype
The AEM Project Archetype is a Maven template that creates a minimal, best-practices-based Adobe Experience Manager (AEM) project as a starting point for your website. This documentation provides an overview of the benefits of the archetype and general usage. Detailed technical instructions and documentation can be found in the archetype GitHub repository.
Why Use the Archetype why-use-the-archetype
Using the AEM Project Archetype sets you on the path towards building a best-practices-based AEM project with just a few keystrokes. By using the archetype, all of the pieces will already in place so that while the resulting project is minimal, it already implements all of the key features of AEM so that all you have to do is build on top and extend.
Of course there are many elements that go into a successful AEM project, but using the AEM Project Archetype is a sound foundation and is strongly recommended for any AEM project.
Features features
- Best Practice: Bootstrap your site with all of Adobe’s latest recommended practices.
- Low-Code: Edit your templates, create content, deploy your CSS, and your site is ready for go-live.
- Cloud-Ready: If desired, use AEM as a Cloud Service to go-live in few days and ease scalability and maintenance.
- Dispatcher: A project is complete only with a Dispatcher configuration that ensures speed and security.
- Multi-Site: If needed, the archetype generates the content structure for a multi-language and multi-region setup.
- Core Components: Authors can create nearly any layout with our versatile set of standardized components.
- Editable Templates: Assemble virtually any template without code, and define what the authors are allowed to edit.
- Responsive Layout: On templates or individual pages, define how the elements reflow for the defined breakpoints.
- Header and Footer: Assemble and localize them without code, using the localization features of the components.
- Style System: Avoid building custom components by allowing authors to apply different styles to them.
- Front-End Build: Front-end developers can mock AEM pages and build client libraries with Webpack, TypeScript, and SASS.
- WebApp-Ready: For sites using React or Angular, use the SPA SDK to retain in-context authoring of the app.
- Commerce Enabled: For projects that want to integrate AEM Commerce with commerce solutions like Magento using the Commerce Core Components.
- Example Code: Checkout the HelloWorld component, and the sample models, servlets, filters, and schedulers.
- Open Sourced: If something is not as it should, contribute your improvements!
Further Reading further-reading
-
AEM Project Archetype GitHub - For full usage and technical details of the archetype
-
Using the Archetype - An overview of how to use the archetype in your project and the resulting modules generated
-
Front-End Development with the AEM Project Archetype - How to use the front-end module of the archetype
-
The following tutorials are based off the archetype:
- WKND Site - Learn how to start a fresh new website.
- WKND Single Page App - Learn how to build a React or Angular webapp that is fully authorable in AEM.