isabella232 / aem-brackets-extension

Brackets extension for Adobe Experience Manager (AEM) front-end developers with auto-sync and HTL support.

AEM Brackets Extension

This extension provides a smooth workflow to edit AEM components and client libraries, and leverages the power of the Brackets code editor, which gives access from within the code editor to Photoshop files and layers. The easy synchronization provided by the AEM Brackets Extension (no Maven or File Vault required) increases developer efficiency and also helps front-end developers with limited AEM knowledge to participate on projects. This extension also provides some HTL support, a template language that takes away the complexity of JSP to make component development easier and more secure.

Documentation

Please refer to the documentation page for instructions on how to install the extension, as well as detailed information about the features.

Get Started

If you don't have of your own a project with a content-package to try out, you can try out the HTL TodoMVC Example sample application that was built with the AEM Brackets Extension. Download the ZIP from GitHub, extract the files locally, open the jcr_root folder in Brackets, setup the Project Settings, and upload the whole package to your AEM development instance by doing an Export Content Package.

After these steps, you should be able to access the /content/todo.html URL on your AEM development instance and you can start doing modifications to the code in Brackets and see how, after doing a refresh in the web browser, the changes were immediately synchronized to the AEM server.

Known Issues or Limitations

• Embedded content packages are not supported.

Reporting Bugs

Please report any issues you encounter using GitHub's issue tracker from.

Development

The AEM Brackets Extension is a Node.js module. The following steps need to be followed if you want to start hacking on new features:

1. install Node.js for your platform

2. clone this repository

   git clone [email protected]:adobe/aem-brackets-extension.git

3. in the aem-brackets-extension folder run

   npm install
   grunt

Contributing

Contributions are welcome! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.