README.md

Your Project's Title...

Your project's description...

Environments

• Preview: https://main--{repo}--{owner}.hlx.page/
• Live: https://main--{repo}--{owner}.hlx.live/

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 eds-react-starter-kit directory in your favorite IDE and start coding :)

Local development - React

For development mode, run the following command,

npm run start

Before committing files, run the following command to generate minified files,

npm run build

Note: Commit the minified files from the /blocks/ folder.

Creating Create Components:

To create components,

npm run add

or

npm run add <component-name>

eg, npm run add address-form

• component-name - should be same as block name.

Feature & Supports

1. pub/sub support to pass data between react app.
2. i18n support. (refer the sample docs and sheets for reference)
3. TypeScript to write React components.
4. Plop is used to generate React base component. Supports TypeScript or JavaScript.
5. Chunk option are enabled, so that dynamic import or React.Lazy works out of the box.

Upcoming enhancements

1. Add Cypress
2. use Portal options