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-guides-boilerplate template and add a mountpoint in the fstab.yaml
2. The URL in fstab.yaml file will always follow the structure: https://dita-franklin-worker.adobeaem.workers.dev/{your_github_user_name}/{git_repository_name}/{branch_name}/{root_folder_name}. {branch_name} and {root_folder_name} should be "main" and "docs" respectively.
3. If you intend to change the branch name and root folder name, create a new branch of the desired name, and created a folder of desired name in that branch. Make sure the branch and folder reflect in your github repository. In this case you need to update your fstab.yaml file with the correct branch and root folder name.
4. Add the AEM Code Sync GitHub App to the repository
5. Create a Github App and give it all the repository permission(read and write or admin, whatever applicable highlest level permission there is), and install it on your repository.
6. Create Edge delivery service profile in AEM Guides.
7. Create Edge delivery service preset in AEM Guides (DO NOT CHECK "push to live" checkbox for now) and publish using the profile created in the previous step. This will add some sample data to your environment.
8. Install the AEM CLI: npm install -g @adobe/aem-cli
9. Start AEM Proxy: aem up (opens your browser at http://localhost:3000)
10. Open the {repo} directory in your favorite IDE and start coding :)

Important

1. Making changes and committing to any .js, .css or any media file will push it to *.hlx.live site as well, be sure that you have tested your changes locally before committing them to your repo.