diva-e-aem / eds-boilerplate

This Adobe Edge Delivery Service (EDS) Boilerplate project offers a streamlined setup for leveraging Adobe Edge Delivery Service (EDS) while working with modern web development tools and practices. It provides a robust foundation for building scalable and performant web applications using web components, TypeScript, and SCSS.
MIT License
2 stars 1 forks source link

Boilerplate for AEM Edge Delivery Services

This is our Edge Delivery Services boilerplate.

Table of Contents

Environments

Prerequisites

Installation

  1. Create your repository using the Boilerplate GitHub repository as a template: https://github.com/divae/boilerplate

  2. Add the AEM Code Sync GitHub App to the repository: https://github.com/apps/aem-code-sync/installations/new

    • Select Only select Repositories (not All Repositories).
  3. Link content source (Google Drive or Microsoft Sharepoint)

    • Create a folder in Google Drive/Sharepoint and share the folder with the Adobe Experience Manager user (helix@adobe.com).
    • Change the reference in fstab.yaml in your GitHub repo to the Google Drive/Sharepoint folder URL and commit the changes.
  4. Install the Sidekick Chrome extension: https://chromewebstore.google.com/detail/aem-sidekick/ccfggkjabjahcjoljmgmklhpaccedipo?pli=1

    • Go to the Google Drive/Sharepoint folder, click on the extension icon in the browser toolbar and select Add this project.
    • To preview and publish content, select a file in Google Drive/Sharepoint, click on the extension icon to open the new Sidekick Toolbar and click preview or publish.
  5. Start development

    • Install the AEM Command Line Interface (CLI) and clone your repo locally.
      npm install -g @adobe/aem-cli
      git clone https://github.com/<owner>/<repo>
    • Change into project folder and start your local dev environment. npm start initializes a build as well as runs the aem up command.
      cd <repo>
      npm start
    • Use Git to push code changes to your preview (https://----.aem.page/) and production (https://----.aem.live/) sites.

Linting

npm run lint

Documentation

For more information, please refer to the documentation.

Preview URLs

Main

Live: https://main--eds-boilerplate--diva-e.aem.live/ Preview: https://main--eds-boilerplate--diva-e.aem.page/

Develop

Live: https://develop--eds-boilerplate--diva-e.aem.live/ Preview: https://develop--eds-boilerplate--diva-e.aem.page/