https://github.com/adobe/aem-boilerplate
Use this repository template for new AEM projects.
https://github.com/adobe/aem-boilerplate
helix helix3 helix4 helix5 repository-template
Last synced: 4 days ago
JSON representation
Use this repository template for new AEM projects.
- Host: GitHub
- URL: https://github.com/adobe/aem-boilerplate
- Owner: adobe
- License: apache-2.0
- Created: 2020-12-11T08:23:05.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-07-30T17:40:14.000Z (6 days ago)
- Last Synced: 2026-07-30T19:08:56.852Z (6 days ago)
- Topics: helix, helix3, helix4, helix5, repository-template
- Language: JavaScript
- Homepage: https://main--aem-boilerplate--adobe.aem.page
- Size: 2.51 MB
- Stars: 192
- Watchers: 44
- Forks: 720
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Your Project's Title...
Your project's description...
## Environments
- Preview: https://main--{repo}--{owner}.aem.page/
- Live: https://main--{repo}--{owner}.aem.live/
## Documentation
Before using the aem-boilerplate, we recommand you to go through the documentation on https://www.aem.live/docs/ and more specifically:
1. [Developer Tutorial](https://www.aem.live/developer/tutorial)
2. [The Anatomy of a Project](https://www.aem.live/developer/anatomy-of-a-project)
3. [Web Performance](https://www.aem.live/developer/keeping-it-100)
4. [Markup, Sections, Blocks, and Auto Blocking](https://www.aem.live/developer/markup-sections-blocks)
## Installation
```sh
npm i
```
## Linting
```sh
npm run lint
```
## Local development
1. Create a new repository based on the `aem-boilerplate` template
1. Add the [AEM Code Sync GitHub App](https://github.com/apps/aem-code-sync) to the repository
1. Install the [AEM CLI](https://github.com/adobe/helix-cli): `npm install -g @adobe/aem-cli`
1. Start AEM Proxy: `aem up` (opens your browser at `http://localhost:3000`)
1. Open the `{repo}` directory in your favorite IDE and start coding :)