# ALFRESCO WEB COMPONENTS

<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>

## Prerequisites

- Alfresco repository with CORS enabled. A Docker-compose file is provided by the [demo-shell](demo-shell-ng2/README.md) app.

## Private Npm repository configuration

All the distribution packages of our components are stored in our private repository visible only from the internal Alfresco lan: 

http://devproducts.alfresco.me:4873

##### How to configure it:

```sh
npm set registry http://devproducts.alfresco.me:4873
npm adduser --registry http://devproducts.alfresco.me:4873
```

##### How to publish on it:

- Add the repository to your package.json. 
ATTENTION: If you don't add the following lines, the package is published on the public Npm repository.

```json
  "publishConfig": {
    "registry": "http://devproducts.alfresco.me:4873/"
  }
```
- Then run the command below each time you want to publish a new version:

```sh
npm version patch
npm publish
```

### Running demo project

*Steps below show the quickest way to get demo shell up and running.*

##### Using setup script (recommended)

```sh
git clone https://github.com/Alfresco/dev-platform-js-api.git
git clone https://github.com/Alfresco/dev-platform-webcomponents.git
cd dev-platform-webcomponents
```

* Start the demo and Install all the dependencies (do it the first time)

```sh
./start.sh -install
```

* Start the demo and update the dependencies

```sh
./start.sh -update
```

* Start the demo 

```sh
./start.sh
```

For development environment configuration please refer to [project docs](demo-shell-ng2/README.md).

## Components

- [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)

## How to build a new component 

If you want generate your Alfresco Angular 2 Component you can use our Yeoman generator
<p align="center">
  <img title="yeoman generator" src='https://github.com/yeoman/media/blob/master/optimized/yeoman-150x150-opaque.png' alt='yeoman logo'  />
</p>

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