# AEM Component Mapping package

[![License](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/adobe/aem-spa-component-mapping/blob/master/LICENSE)
[![NPM Version](https://img.shields.io/npm/v/@adobe/aem-spa-component-mapping.svg)](https://www.npmjs.com/package/@adobe/aem-spa-component-mapping)
[![Documentation](https://img.shields.io/badge/docs-api-blue)](https://opensource.adobe.com/aem-spa-component-mapping/)

[![codecov](https://codecov.io/gh/adobe/aem-spa-component-mapping/branch/master/graph/badge.svg)](https://codecov.io/gh/adobe/aem-spa-component-mapping)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adobe_aem-spa-component-mapping&metric=alert_status)](https://sonarcloud.io/dashboard?id=adobe_aem-spa-component-mapping)
[![Known Vulnerabilities](https://snyk.io/test/github/adobe/aem-spa-component-mapping/badge.svg)](https://snyk.io/test/github/adobe/aem-spa-component-mapping)
[![Dependencies](https://badges.renovateapi.com/github/adobe/aem-spa-component-mapping?)](https://app.renovatebot.com/dashboard#github/adobe/aem-spa-component-mapping)

A storage library for front-end components. Provides a way for the Single Page Application to map front-end components to Adobe Experience Manager resource types (AEM Components). The SPA Editor is the recommended solution for projects that use a SPA framework (React or Angular). 
For more information please see the [documentation](https://docs.adobe.com/content/help/en/experience-manager-65/developing/headless/spas/spa-dynamic-model-to-component-mapping.html).


## Installation 
```
npm install @adobe/aem-spa-component-mapping
```

## Documentation 

* [SPA Editor Overview](https://www.adobe.com/go/aem6_5_docs_spa_en)
* [SPA Architecture](https://docs.adobe.com/content/help/en/experience-manager-65/developing/headless/spas/spa-architecture.html)
* [Getting Started with the AEM SPA Editor and Angular](https://docs.adobe.com/content/help/en/experience-manager-learn/spa-angular-tutorial/overview.html)
* [Getting Started with the AEM SPA Editor and React](https://docs.adobe.com/content/help/en/experience-manager-learn/spa-react-tutorial/overview.html)

## Contributing

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

## Licensing

This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.