Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/aem-design/aemdesign-aem-core

An implementation of AEM.Design component concepts
https://github.com/aem-design/aemdesign-aem-core
addthis aem analytics-data-layer audio best-practices breadcrumb columns embed-source google-analytics google-map image list nav-list rest salesforce-api send-email tag-list video wcm-components
Last synced: 3 months ago
JSON representation
An implementation of AEM.Design component concepts
Host: GitHub
URL: https://github.com/aem-design/aemdesign-aem-core
Owner: aem-design
License: apache-2.0
Created: 2019-07-20T04:39:12.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2022-09-11T09:11:47.000Z (over 2 years ago)
Last Synced: 2024-04-14T16:10:04.350Z (10 months ago)
Topics: addthis, aem, analytics-data-layer, audio, best-practices, breadcrumb, columns, embed-source, google-analytics, google-map, image, list, nav-list, rest, salesforce-api, send-email, tag-list, video, wcm-components
Language: JavaScript
Homepage: http://aem.design
Size: 12.9 MB
Stars: 19
Watchers: 11
Forks: 11
Open Issues: 30
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        # AEM.Design Core 

[![build_status](https://github.com/aem-design/aemdesign-aem-core/workflows/ci/badge.svg?branch=develop)](https://github.com/aem-design/aemdesign-aem-core/actions?workflow=ci)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=design.aem%3Aaemdesign-aem-core&metric=alert_status)](https://sonarcloud.io/dashboard?id=design.aem%3Aaemdesign-aem-core)

[![codecov](https://codecov.io/gh/aem-design/aemdesign-aem-core/branch/master/graph/badge.svg?magic)](https://codecov.io/gh/aem-design/aemdesign-aem-core)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/design.aem/aemdesign-aem-common/badge.svg?magic)](https://maven-badges.herokuapp.com/maven-central/design.aem/aemdesign-aem-common)

[![github license](https://img.shields.io/github/license/aem-design/aemdesign-aem-core)](https://github.com/aem-design/aemdesign-aem-core) 

[![github issues](https://img.shields.io/github/issues/aem-design/aemdesign-aem-core)](https://github.com/aem-design/aemdesign-aem-core) 

[![github last commit](https://img.shields.io/github/last-commit/aem-design/aemdesign-aem-core)](https://github.com/aem-design/aemdesign-aem-core) 

[![github repo size](https://img.shields.io/github/repo-size/aem-design/aemdesign-aem-core)](https://github.com/aem-design/aemdesign-aem-core) 

[![github repo size](https://img.shields.io/github/languages/code-size/aem-design/aemdesign-aem-core)](https://github.com/aem-design/aemdesign-aem-core) 

[![github release](https://img.shields.io/github/release/aem-design/aemdesign-aem-core)](https://github.com/aem-design/aemdesign-aem-core)

[![CodeFactor](https://www.codefactor.io/repository/github/aem-design/aemdesign-aem-core/badge)](https://www.codefactor.io/repository/github/aem-design/aemdesign-aem-core)

[![Visit AEM.Design](https://img.shields.io/badge/visit-aem.design-brightgreen)](https://aem.design/)

[![Gitter](https://img.shields.io/gitter/room/aem-design/Lobby)](https://gitter.im/aem-design/Lobby)

A set of standardized components for AEM 6.4+ that can be used to speed up development of websites.

## Documentation

* [AEM.Design Blog](https://aem.design)

* [AEM.Design SonarCloud](https://sonarcloud.io/project/issues?id=design.aem%3Aaemdesign-aem-core)

You will require a latest version of [aemdesign-aem-compose](https://github.com/aem-design/aemdesign-aem-support/releases) that has the base dialog's configuration content. 

## Development

If you're curious about how the next generation of components looks like, a tech preview is made available in the

[`develop`](https://github.com/aem-design/aemdesign-aem-core/tree/develop) branch.

## Contributing

Contributions are welcome! Read the [Contributing Guide](CONTRIBUTING.md) for more information.

## Available Components

Detailed table of component can be found here [Component List](https://github.com/aem-design/aemdesign-aem-core/wiki/Component-List)

| Component Category 
|----------------------- 
| Cloud Services / Rest 
| Cloud Services / Salesforce API 
| Common / Redirection Notification 
| Common / Static Content Include 
| Common / Timing Component 
| Content / File Download Link 
| Content / Embed Source 
| Content / External 
| Content / Link 
| Content / Content Reference 
| Content / Content Fragment 
| Content / Content Template 
| Content / Table 
| Content / Rich Text 
| Content / Tool Tip 
| Content / Page Author 
| Content / Page Date 
| Content / Page Description 
| Content / Page Tags 
| Content / Page Title 
| Details / Generic Details 
| Details / Contact Details 
| Details / Event Details 
| Details / Location Details 
| Details / News Details 
| Details / Page Details 
| Layout / Article 
| Layout / Aside 
| Layout / Breadcrumb 
| Layout / Columns 
| Layout / Content Block 
| Layout / Content Block Lock 
| Layout / Content Block Menu 
| Layout / Content Tabs 
| Layout / Footer 
| Layout / Header 
| Layout / Nav Bar 
| Layout / Container 
| Lists / Asset List 
| Lists / Contact List 
| Lists / Event List 
| Lists / Lang Nav 
| Lists / List 
| Lists / List Nav 
| Lists / Location List 
| Lists / News List 
| Lists / Page List 
| Lists / Search Results List 
| Lists / Tag List 
| Lists / Nav List 
| Media / Audio 
| Media / Image 
| Media / Video 
| Analytics / Analytics Data Layer 
| Template / AEM.Design Base Page 
| Template / Cloud Config / AddThis 
| Template / Cloud 
| Template / Cloud 
| Template / Column 
| Template / Column 
| Template / Column 
| Template / Common 
| Template / Experience 
| Widgets / AddThis / Addthis Button 
| Widgets / Online Media 
| Widgets / Search Box 
| Workflow / Process Payload 
| Workflow / Project Task Manager 
| Workflow / Project Update 
| Workflow / Rest 
| Workflow / Salesforce API 
| Workflow / Send Email 
| Coral / Common/Form / Tag Field 
| Coral / Datasources / Forms 
| Coral / Datasources / Tags 
| Coral / Foundation / Accordion 
| Coral / Widgets/Form 
| Replication / Akamai Cache Flush

| Link                                                                                                                                   	| ------------------------------------------	|----------------------------------------------------------------------------------------------------------------------------------------	| | [Rest](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/workflow/rest)                                                           	| | [Salesforce API](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/workflow/salesforceapi)                                        	| | [Redirection Notification](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/common/redirectnotification/v2/redirectnotification) 	| | [Static Content Include](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/common/staticinclude/v2/staticinclude)                 	| | [Timing Component](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/common/timing/v2/timing)                                     	| | [File Download Link](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/download/v2/download)                              	| | [Embed Source](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/embedsource/v2/embedsource)                              	| | [External](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/external/v2/external)                                        	| | [Link](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/link/v2/link)                                                    	| | [Content Reference](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/reference/v2/reference)                             	| | [Content Fragment](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/contentfragment)                                     	| | [Content Template](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/contenttemplate/v1/contenttemplate)                  	| | [Table](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/table/v2/table)                                                 	| | [Rich Text](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/text/v2/text)                                               	| | [Tool Tip](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/tooltip/v2/tooltip)                                          	| | [Page Author](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/pageauthor/v2/pageauthor)                                 	| | [Page Date](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/pagedate/v2/pagedate)                                       	| | [Page Description](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/pagedescription/v2/pagedescription)                  	| | [Page Tags](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/pagetags/v2/pagetags)                                       	| | [Page Title](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/content/pagetitle/v2/pagetitle)                                    	| | [Generic Details](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/details/generic-details/v1/generic-details)                   	| | [Contact Details](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/details/contact-details/v2/contact-details)                   	| | [Event Details](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/details/event-details/v2/event-details)                         	| | [Location Details](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/details/location-details/v2/location-details)                	| | [News Details](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/details/news-details/v2/news-details)                            	| | [Page Details](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/details/page-details/v2/page-details)                            	| | [Article](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/article/v2/article)                                            	| | [Aside](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/aside/v2/aside)                                                  	| | [Breadcrumb](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/breadcrumb/v2/breadcrumb)                                   	| | [Columns](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/colctrl/v2/colctrl)                                            	| | [Content Block](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/contentblock/v2/contentblock)                            	| | [Content Block Lock](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/contentblocklock)                                   	| | [Content Block Menu](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/contentblocklock/v2/contentblocklock)               	| | [Content Tabs](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/contenttabs/v2/contenttabs)                               	| | [Footer](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/footer/v2/footer)                                               	| | [Header](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/header/v2/header)                                               	| | [Nav Bar](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/navbar/v2/navbar)                                              	| | [Container](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/layout/container)                                                   	| | [Asset List](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/assetlist/v2/assetlist)                                      	| | [Contact List](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/contactlist/v2/contactlist)                                	| | [Event List](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/eventlist/v2/eventlist)                                      	| | [Lang Nav](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/langnav/v2/langnav)                                            	| | [List](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/list/v2/list)                                                      	| | [List Nav](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/listnav/v2/listnav)                                            	| | [Location List](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/locationlist/v2/locationlist)                             	| | [News List](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/newslist/v2/newslist)                                         	| | [Page List](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/pagelist/v2/pagelist)                                         	| | [Search Results List](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/searchlist/v2/searchlist)                           	| | [Tag List](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/taglist/v2/taglist)                                            	| | [Nav List](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/lists/navlist/v2/navlist)                                            	| | [Audio](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/media/audio/v2/audio)                                                   	| | [Image](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/media/image/v2/image)                                                   	| | [Video](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/media/video/v2/video)                                                   	| | [Analytics Data Layer](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/analytics/datalayer/v2/datalayer)                        	| | [AEM.Design Base Page](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/template/base/v3/base)                                   	| | [AddThis](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/template/cloudconfig/addthisconnect/config)                           	| Config / Google Analytics                      	| [Google Analytics](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/template/cloudconfig/googleanalytics/config)                 	| Config / Google Map                            	| [Google Map](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/template/cloudconfig/googlemap/config)                             	| / AEM.Design One Column Page                  	| [AEM.Design One Column Page](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/template/column/one/v2/one)                        	| / AEM.Design Three Column Page                	| [AEM.Design Three Column Page](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/template/column/three/v2/three)                  	| / AEM.Design Two Column Page                  	| [AEM.Design Two Column Page](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/template/column/two/v2/two)                        	| / Design Importer                             	| [Design Importer](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/template/common/design-importer)                              	| Fragment / AEM.Design Experience Fragment 	| [AEM.Design Experience Fragment](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/template/experience-fragments/base/v2/xfpage)  	| | [Addthis Button](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/widgets/addthis/sharebutton/v2/sharebutton)                    	| | [Online Media](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/widgets/onlinemedia/v2/onlinemedia)                              	| | [Search Box](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/widgets/search/v2/search)                                          	| | [Process Payload](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/workflow/processpayload)                                      	| | [Project Task Manager](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/workflow/projecttaskmanager)                             	| | [Project Update](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/workflow/projectupdate)                                        	| | [Rest](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/workflow/rest)                                                           	| | [Salesforce API](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/workflow/salesforceapi)                                        	| | [Send Email](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/workflow/sendemail)                                                	| | [Tag Field](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/coral/common/form/tagfield)                                         	| | [Forms](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/coral/datasources/forms)                                                	| | [Tags](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/coral/datasources/tags)                                                  	| | [Accordion](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/coral/foundation/accordion)                                         	| / Asset Options                            	| [Asset Options](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/coral/widgets/form/assetoptions)                                	| | [Akamai Cache Flush](https://github.com/aem-design/aemdesign-aem-core/tree/master/aemdesign-aem-common/src/main/content/jcr_root/apps/aemdesign/components/replication/akamai)                                	|

## Component Versioning

The components' versioning scheme is documented on the [AEM Core WCM Components' versioning policies](https://github.com/adobe/aem-core-wcm-components/wiki/Versioning-policies) wiki page.

## Module Purpose

Following is a description of each repo and their purpose.

For more information see [Project Artifacts](http://aem.design/manifesto/project/#project-artifacts)

| Repo                            | Notes                                       |

|---------------------------------|---------------------------------------------|

| aemdesign-aem-author/           | has all of the components and configurations that modify/update AEM |

| aemdesign-aem-common/           | has all of the components code |

| aemdesign-aem-core-deploy/      | monolith package for all projects           |

| aemdesign-aem-services/         | has all of the code that compiled and installed by common project |

## System Requirements

The latest version of the Core Components, require the below system requirements:

| AEM Version   | [2.0.0](https://github.com/aem-design/aemdesign-aem-core/tag/2.0.0) |

| -----         | ---   |

| 6.4           | yes   |

| 6.5           | yes   |

## Installation

To install everything, excluding examples, the [released aggregate package `aemdesign-aem-core-deploy`](https://github.com/aem-design/aemdesign-aem-core/releases) can be installed via the AEM Package Manager.

For more information about the Package Manager please have a look at [How to Work With Packages](https://helpx.adobe.com/experience-manager/6-4/sites/administering/using/package-manager.html) documentation page.

### Package Dependencies

Following packages are dependencies and should be installed on your AEM instance before installing AEM.Design:

- [ACS Twitter 1.0.0](https://github.com/Adobe-Consulting-Services/com.adobe.acs.bundles.twitter4j/releases/download/com.adobe.acs.bundles.twitter4j-1.0.0/com.adobe.acs.bundles.twitter4j-content-1.0.0.zip)

- [ACS Commons 4.4.0](https://github.com/Adobe-Consulting-Services/acs-aem-commons/releases/download/acs-aem-commons-4.4.0/acs-aem-commons-content-4.4.0.zip)

- [Core Components 2.8.0](https://github.com/adobe/aem-core-wcm-components/releases/download/core.wcm.components.reactor-2.8.0/core.wcm.components.all-2.8.0.zip)

- [Core Components Extension 1.0.12](https://github.com/adobe/aem-core-wcm-components/releases/download/core.wcm.components.reactor-2.3.2/core.wcm.components.extension-1.0.12.zip)

- [Netcentric Access Control Tool 2.3.2](http://repo1.maven.org/maven2/biz/netcentric/cq/tools/accesscontroltool/accesscontroltool-package/2.3.2/accesscontroltool-package-2.3.2.zip)

- [Adobe Vanity URL 1.0.2](https://www.adobeaemcloud.com/content/companies/public/adobe/packages/cq600/component/vanityurls-components/jcr%3acontent/package/file.res/vanityurls-components-1.0.2.zip)

## Build

The project has the following requirements:

* Java SE Development Kit 8 or Java SE Development Kit 11

* Apache Maven 3.3.1 or newer

For ease of build and installation the following profiles are provided:

 * ``installdeploymentpackage`` - installs the deploy package/bundle to an existing AEM author instance

You can use helper script for ease of local deployment

* ``deploy-local`` - deploy aemdesign-aem-core-deploy package to your local AEM instance running on port 4502

* ``deploy-local-publish`` - deploy aemdesign-aem-core-deploy package to your local AEM instance running on port 4503

### UberJar

This project relies on the AEM 6.4 cq-quickstart. This is publicly available on https://repo.adobe.com

For more details about the UberJar please head over to the

[How to Build AEM Projects using Apache Maven](https://helpx.adobe.com/experience-manager/6-4/sites/developing/using/ht-projects-maven.html) documentation page.

## Include core components into your own project maven build

To add core components to your project, you will need to add it to your maven build.

The released version of the framework are available on the public maven repository at https://repo1.maven.org/maven2/design/aem/aemdesign-aem-core-deploy/ 

To include the deploy package into your own project's maven build using maven you can add the dependency to your pom.xml like this

 ```

 

     design.aem

     aemdesign-aem-core-deploy

     zip

     2.0.100

 

 ```

and then add this subpackage to your sub package section

```

 

     design.aem

     aemdesign-aem-core-deploy

     true

 

```

inside the configuration of the `content-package-maven-plugin`.

# Development Notes

Following section describes some of the development topics

## Version Convention

Version numbers for Git Tags should follow semver format:

 * **MAJOR** version when you make incompatible API changes,

 * **MINOR** version when you add functionality in a backwards-compatible manner, and

 * **PATCH** version when you make small incremental changes

## Minimal core artifacts required for providing overridable AEM components.

 

`aemdesign-aem-core-deploy` module creates an aem package for deployment which contains:

 * `aemdesign-aem-author`

 * `amedesign-aem-common`

 

`aemdesign-aem-common` module embeds bundles:

 * `aemdesign-aem-services` 

 

## To build

To ensure the project builds correctly locally run:

`mvn -Dvault.useProxy=false -DskipTests -e -U clean package`

## To deploy

To build and deploy the project to your local aem instance (default localhost:4502), in the project root run:

`./deploy-local`

## To create a release

Releases are managed via the maven plugins `versions-maven-plugin` and `maven-scm-plugin`

Version numbers should follow the [SemVer](https://semver.org/) convention.

## Release Versions

Release versions are automated and based on Tags in format MAJOR.MINOR and Commit count from Tag using the `git describe` command.

To test git versioning run

`git describe`

this will show you generated version message with latest tag and how many commits since tag.

If you get an error:

`fatal: No annotated tags can describe`

create a new tag for your current version MAJOR.MINOR, the rest will be automated:

`git tag 2.1 -f -m "2.1"`

To create a release all you need to do is create a tag MAJOR.MINOR on master branch and push it.

## Version Convention

Version numbers for Git Tags should follow semver format:

 * MAJOR version when you make incompatible API changes,

 * MINOR version when you add functionality in a backwards-compatible manner, and

 * PATCH version is automatically generated based on git commit count from last Tag

Please use MAJOR and MINOR version in Tags, PATCH version will be automatically added as a commit count since the last tag using the git describe.

## Release history

Please review the [change log](CHANGELOG.md) for all version history.

## Commit Signatures

Please ensure you have GPG setup and you sign all of your commits.