mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
56ad824fb4
* [AAE-6358] added storybook section to core readme * [AAE-6358] added storybook seciton to content-services readme * [AAE-6358] fixed content-services readme * [AAE-6358] added storybook section to process-services-cloud readme * [AAE-6358] added readme for stories library * [AAE-6358] added libraries list do root readme
76 lines
3.7 KiB
Markdown
76 lines
3.7 KiB
Markdown
# Alfresco Application Development Framework (ADF)
|
|
|
|
| branch | status |
|
|
| --- | --- |
|
|
| master | [](https://travis-ci.com/Alfresco/alfresco-ng2-components) |
|
|
| develop | [](https://travis-ci.com/Alfresco/alfresco-ng2-components) |
|
|
|
|
[](https://www.codacy.com/app/Alfresco/alfresco-ng2-components?utm_source=github.com&utm_medium=referral&utm_content=Alfresco/alfresco-ng2-components&utm_campaign=badger)
|
|
[](https://gitter.im/Alfresco/alfresco-ng2-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
<p>
|
|
<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>
|
|
</p
|
|
|
|
## Introduction
|
|
|
|
See the [Introduction page](INTRODUCTION.md) to get started with 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 the prerequisites section in [creating your first ADF Application](./docs/tutorials/creating-your-first-adf-application.md) for full details.
|
|
|
|
## Components
|
|
|
|
You can find the sources for all ADF components in the
|
|
[`lib`](/lib) folder.
|
|
|
|
Full documentation for all components is available at the
|
|
[ADF Component Catalog](https://alfresco.github.io/adf-component-catalog/).
|
|
|
|
## Libraries
|
|
|
|
ADF Libraries list:
|
|
- [Content services](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/content-services)
|
|
- [Core](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/core)
|
|
- [Extensions](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/extensions)
|
|
- [Insights](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/insights)
|
|
- [Process Service Cloud](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/process-services-cloud)
|
|
- [Process service](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/process-services)
|
|
- [Stories](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/stories)
|
|
|
|
## Demo Application
|
|
|
|
A separate application showcasing integration of components can be found
|
|
[here](https://github.com/Alfresco/alfresco-ng2-components/tree/master/demo-shell).
|
|
The app has examples of basic interaction for both APS and ACS components.
|
|
|
|
## Yeoman generators
|
|
|
|
To speed up the development of your ADF application, use the
|
|
[Yeoman Generator](https://github.com/Alfresco/generator-ng2-alfresco-app).
|
|
This 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>
|
|
|
|
## Browser Support
|
|
|
|
All components are supported in the following browsers:
|
|
|
|
|**Browser** |**Version** |
|
|
|--- |--- |
|
|
|Chrome |Latest |
|
|
|Safari (OS X) |9.x |
|
|
|Firefox* |Latest |
|
|
|Edge |13, 14 |
|
|
|Internet Explorer |11 |
|
|
|
|
* Due to a [known issue](https://bugzilla.mozilla.org/show_bug.cgi?id=1188880) in Firefox, the Alfresco Upload Component does not currently support folder upload functionality on Firefox.
|
|
|
|
See the [Browser Support](BROWSER-SUPPORT.md) article for more details.
|
|
|