mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
87 lines
3.8 KiB
Markdown
87 lines
3.8 KiB
Markdown
# ALFRESCO ANGULAR 2 COMPONENTS
|
|
|
|
[](https://gitter.im/Alfresco/alfresco-ng2-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
<p>
|
|
<a title='Build Status Travis' href="https://travis-ci.org/Alfresco/alfresco-ng2-components">
|
|
<img src='https://travis-ci.org/Alfresco/alfresco-ng2-components.svg?branch=master' alt='travis
|
|
Status' />
|
|
</a>
|
|
<a title='Build Status AppVeyor' href="https://ci.appveyor.com/project/alfresco/alfresco-ng2-components">
|
|
<img src='https://ci.appveyor.com/api/projects/status/github/Alfresco/alfresco-ng2-components' alt='travis
|
|
Status' />
|
|
</a>
|
|
<a href='https://codecov.io/gh/Alfresco/alfresco-ng2-components'>
|
|
<img src='https://img.shields.io/codecov/c/github/Alfresco/alfresco-ng2-components/master.svg?maxAge=2592000' alt='Coverage Status' />
|
|
</a>
|
|
<a href='https://github.com/Alfresco/alfresco-ng2-components/blob/master/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>
|
|
</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)
|
|
- [Webscript viewer](ng2-components/ng2-alfresco-webscript/README.md)
|
|
|
|
You can browse all the components at the following [page](http://devproducts.alfresco.com/).
|
|
|
|
## 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)
|
|
|
|
|
|
|