Application Development Framework examples

This repository contains a collection of examples of simple (and less simple) projects developed using the Alfresco Application Developer Framework.

Goal of the ADF examples

The goal of the repository is to provide working source code as an example, and some useful components to be used as inspiration for your use cases and custom applications. The idea is to enable developers, sharing some best practices and useful tips to reduce the learning curve and the time to market of your artifacts. We are committed to increase this collection of projects in number and complexity during the near future, to give you the a practical place where to find working examples to start (or experiment) your development.

Introduction to the Alfresco ADF

Before downloading and trying to use the ADF examples, be sure you covered the basis of Angular2 and Alfresco Application Developer Framework. For an introduction to the Alfresco ADF, you can refer to the Getting Started page of the Alfresco Community Portal. For further details about the Alfresco ADF, below you can find some useful links.

• Alfresco ADF catalog of components
• Alfresco REST API
• Gitter chat about Alfresco ADF

About the structure of the repository

For a better understanding, the structure of the repository is organized by Alfresco ADF version. Each example is organized as an independent project and named as much clear as possible, to introduce the main topic covered. Each project contains at least a README file introducing the use case, the environment, the used versions and prerequisites in general. Below an example of repository structure, representing the two levels: the Alfresco ADF version and the projects.

|-- adf-examples
    |-- ADF X.X.X
        |-- Project 1
        |-- Project 2
        |-- ...
    |-- ADF Y.Y.Y
        |-- Project 3
        |-- Project 4
        |-- ...
    |-- README.md
    |-- ...

To view the full list of examples related to an Alfresco ADF version, click on the folder named like the ADF version.

Where to start

To start using the Alfresco ADF examples, you simply need to follow the tasks listed below.

• Clone the repository. Opening a terminal and running the command below.

git clone https://github.com/Alfresco/adf-examples

• Checking the projects hosted into it. After the clone, a folder adf-example will be created into your file system. Dive into the folder structure and choose you preferred project to run.

For further details about each project, check the README file containing the description of the use case, the prerequisites and how to make it work.

Improving the collection of examples

We are always committed to enable developers improving the collection of ADF examples, but no guarantee can be given for a regular extension of the existing or new examples. If you cannot find your specific use case, please let us know raising a new issue or commenting an existing one. Before opening a new issue, please always check if one similar to your use case already exists.

How to receive support

If one (or more) of the examples don't work for you, you'd probably need support. This is not the right place to ask (and receive) support because exists a better place for it:

Feel free to ask there.

License and disclaimer

Copyright (C) 2017 Alfresco Software Limited

Alfresco Software Limited licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.