Brightpath

EDS Experiementation

Environments

• Preview: https://main--brightpath--kmurugulla.aem.page/
• Live: https://main--brightpath--kmurugulla.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
2. The Anatomy of a Project
3. Web Performance
4. Markup, Sections, Blocks, and Auto Blocking

Installation

npm i

Linting

npm run lint

Performance Budget

For detailed setup instructions and documentation, see PERFORMANCE_BUDGET_SETUP.md.

Automated Testing (GitHub Actions)

Performance tests automatically run on every PR against the branch's preview URL:

• Triggers: When you create a PR to main
• Tests: Branch preview URL (e.g., https://{branch}--{repo}--{owner}.aem.live)
• Paths: Configured in .github/workflows/performance-budget.yml (env PERF_TEST_PATHS)
• Results: Posted as a comment on the PR

To configure tested paths, edit .github/workflows/performance-budget.yml:

env:
  PERF_TEST_PATHS: '/ /da-demo /ue-editor/demo'

Manual Testing (Local)

# Test localhost
npm run perftest
npm run perftest -- /about /contact

# Test branch preview URL
npm run perftest -- --url https://{branch}--{repo}--{owner}.aem.live / /about

# Test production
npm run perftest -- --url https://{branch}--{repo}--{owner}.aem.live

# Check file sizes
npm run perftest:size

Local development

1. Create a new repository based on the aem-boilerplate template
2. Add the AEM Code Sync GitHub App to the repository
3. Install the AEM CLI: npm install -g @adobe/aem-cli
4. Start AEM Proxy: aem up (opens your browser at http://localhost:3000)
5. Open the {repo} directory in your favorite IDE and start coding :)