exlm's Introduction

Experience League

Experience League site implementation on https://aem.live

Environments

Getting started

Clone or fork this repo (see note below on forking)
Create your brannch
Install the AEM CLI: npm install -g @adobe/aem-cli
Install dependencies npm i
Start Local Proxy: aem up (opens your browser at http://localhost:3000)
Start coding!

On forking this repo

If you want/need to fork this repository remember to add the AEM Code Sync GitHub App to the fork repository.

Content Source

The default content source is set in fstab.yaml, by default it's pointing to the main exlm-converter action.

The action is the entry point for all HTML delivered to https://aem.live services.

while developing, and if you need to update the source HTML, you are free to deploy exlm-converter action to your own project on Adobe Runtime. (Remember to point your forked repon fstab.yaml to your own action).

Helpful Commands

Linting

npm run lint

Fix auto-fixable CSS lint issues

npm run quality

Code Formatting

this should happen on commit automatically, but you can run manually with:

npm run format

Code Quality Check

If you want to run all code quality scripts to ensure your PR will pass:

npm run quality

Run sass auto-compile and Helix Pages

npm run up

The above command will run node sass-compile.js in parallel with hlx up which will start your local Helix Pages development environment.

Note on SASS usage and Helix Local Development

The npm run up will parse the styles and blocks directory for any .scss files. Files that are found will be compiled to css and saved in the same location and name with a .css extension. It will then continue to watch for changes to .scss files and will compile to their associated CSS files on changes.

Examples:

{repo}/blocks/header/header.scss will compile to {repo}/blocks/header/header.css
{repo}/styles/style.scss will compile to {repo}/styles/styles.css

As both sass-compile.js and hlx up are watching for changes, changes made to your sass files while using the rpm run up command will be reflected automatically in your localhost.

Note that using only the hlx up command will not trigger updates on-change for sass files.

Local SignedIn Development

Use this only if you need sign-in to work locally for development purposes.

add this entry to hosts file (/etc/hosts on mac) 127.0.0.1 experienceleague-local.adobe.com (you likely will need sudo to save this file)
run npm run up-secure (instead of npm run up)
Browser should automatically open at https://experienceleague-local.adobe.com

if asked to trust the certificate on the browser, do trust it. Might also need to allow runnig nas admin (sudo)

If you have a Windows machine, please add any learnings to this Doc. The current dev team uses MacOs.

exlm's People

Contributors

Stargazers

Watchers

exlm's Issues

Content model changes (phase 2)

To achieve a more compelling content model that aligns with the best practices of Edge Delivery Services we should:

reduce the number of authorable columns and rows
group / concatenate semantically related content elements into single column (SITES-19302)

Affected blocks:

Scope:

use the semantic html served directly and annotate it with css classes, instead of parsing and rebuilding the DOM
concatenate the properties into single columns as outlined above (involves renaming properties)
provide according content migration "scripts" (sling pipes)

Recommend Projects

adobe-experience-league / exlm Goto Github PK