README.md

Your Project's Title...

Your project's description...

Environments

• Preview: https://main--aem-boilerplate-forms--adobe-rnd.aem.page/
• Live: https://main--aem-boilerplate-forms--adobe-rnd.aem.live/

Documentation

Before using the aem-boilerplate, we recommand you to go through the documentation on www.aem.live and experienceleague.adobe.com, more specifically:

• Getting Started Guide
• Creating Blocks
• Content Modelling
• Working with Tabular Data / Spreadsheets

Furthremore, we encourage you to watch the recordings of any of our previous presentations or sessions:

• Getting started with AEM Forms Authoring and Edge Delivery Services

Prerequisites

• nodejs 18.3.x or newer
• AEM Cloud Service release 2024.8 or newer (>= 17465)

Installation

npm i

Linting

npm run lint

Local development

1. Create a new repository based on the aem-boilerplate template and add a mountpoint in the fstab.yaml
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 :)

Custom Form Components

Create custom form components using the interactive scaffolder:

npm run create:custom-component

This will guide you through creating a new custom component with:

• Interactive prompts for component name and base type
• Automatic file generation (JS, CSS, JSON)
• Automatic integration in form block with mappings

Updating Runtime Core

The AEM Forms runtime core libraries (@aemforms/af-core and @aemforms/af-formatters) power the form rendering and validation logic. These libraries are bundled into the project using Rollup to optimize performance and ensure compatibility.

Update Process

1. Find the Latest Version

   • Navigate to the af2-web-runtime repository
   • Check the commit history or releases for the latest versions of:
     • @aemforms/af-core
     • @aemforms/af-formatters
   • Note: Both packages should typically be updated to the same version number

2. Update Package Dependencies

   • Manually edit package.json in the devDependencies section
   • Update both packages to the same version:

     "@aemforms/af-core": "x.xx.xxx",
     "@aemforms/af-formatters": "x.xx.xxx"

3. Install Dependencies

   npm install

   This will download the new versions from the npm registry.

4. Bundle the Runtime

   npm run update

   This command runs Rollup to bundle the updated libraries into blocks/form/rules/model/.

5. Verify the Update

   • Check that files in blocks/form/rules/model/ have been updated