# Alfresco Insights Components

Contains a variety of components, directives and services used throughout ADF to provide insights into the data stored in Alfresco.

## Documentation

See the [ADF Insights](../../docs/README.md#insights) section of the [docs index](../../docs/README.md)
for all available documentation on this library.

## Prerequisites

Before you start using this development framework, make sure you have installed all required software and done all the
necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).

> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)

## Install

```sh
npm install @alfresco/adf-insights
```

## Components

| Name                                                                               | Description                                              |
|------------------------------------------------------------------------------------|----------------------------------------------------------|
| [Analytics Generator Component](docs/components/analytics-generator.component.md)  | Generates and shows charts                               |
| [APS Analytics List Component](docs/components/analytics-report-list.component.md) | Shows a list of all available reports                    |
| [APS Analytics Component](docs/components/analytics.component.md)                  | Shows the charts related to the reportId passed as input |
| [Diagram Component](docs/components/diagram.component.md)                          | Displays process diagrams.                               |