# ALFRESCO ANGULAR 2 COMPONENTS

<p>
  <a href='https://raw.githubusercontent.com/Alfresco/dev-platform-webcomponents/master/ng2-components/ng2-alfresco-viewer/LICENSE'>
     <img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
  </a>
  <a href='https://www.alfresco.com/'>
     <img src='https://img.shields.io/badge/style-component-green.svg?label=alfresco' alt='alfresco component' />
  </a>
  <a href='https://angular.io/'>
     <img src='https://img.shields.io/badge/style-2-red.svg?label=angular' alt='angular 2' />
  </a>
  <a href='https://www.typescriptlang.org/docs/tutorial.html'>
     <img src='https://img.shields.io/badge/style-lang-blue.svg?label=typescript' alt='typescript' />
  </a>
  <a href='https://www.alfresco.com/'>
     <img src='https://img.shields.io/badge/style-%3E5.0.0-blue.svg?label=node%20version' alt='node version' />
  </a>
  <a title='Build Status' href="https://travis-ci.com/Alfresco/alfresco-ng2-components">
    <img src='https://travis-ci.com/Alfresco/alfresco-ng2-components.svg?token=SCyeWaC53Nr62GmuRyZA&branch=master'  alt='travis
    Status' />
  </a>
  <a href='https://coveralls.io/github/Alfresco/app-dev-framework'>
    <img src='https://coveralls.io/repos/github/Alfresco/app-dev-framework/badge.svg?t=SfuVVj' alt='Coverage Status' />
  </a>
</p>
  
<p align="center">
  <img title="alfresco" alt='alfresco' src='assets/alfresco.png'  width="280px" height="150px"></img>
  <img title="angular2" alt='angular2' src='assets/angular2.png'  width="150px" height="150px"></img>    
</p>

## Introduction

See the following [page](Introduction.md) for an introduction to the Alfresco Application Development Framework. 

## 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](Prerequisites.md).

## Components

The following is a list of some of the components that you can use when building your custom Alfresco web client:

- [Core library](ng2-components/ng2-alfresco-core/README.md)
- [DataTable](ng2-components/ng2-alfresco-datatable/README.md)
- [DocumentList](ng2-components/ng2-alfresco-documentlist/README.md)
- [Viewer](ng2-components/ng2-alfresco-viewer/README.md)
- [Login](ng2-components/ng2-alfresco-login/README.md)
- [Upload](ng2-components/ng2-alfresco-upload/README.md)

You can browse all the components at the following [page](http://devproducts.alfresco.me/).

## Yeoman generators

To speed up the development of your Alfresco Angular 2 application, or Alfresco Angular 2 component, use one of the Yeoman generators. 

These generators will create a full working project with all the right libraries and tools.

<p align="center">
  <img title="yeoman generator" src='https://github.com/yeoman/media/blob/master/optimized/yeoman-150x150-opaque.png' alt='yeoman logo'  />
</p>

### Generate an Alfresco web component starter project

To generate your Alfresco Angular 2 component you can use the following Yeoman generator:

- [Yeoman Generator Angular 2 Alfresco component](https://github.com/Alfresco/generator-ng2-alfresco-component)


### Generate an Alfresco web application starter project

To generate your Alfresco Angular 2 application you can use the following Yeoman generator:

- [Yeoman Generator Angular 2 Alfresco application](https://github.com/Alfresco/generator-ng2-alfresco-app)