To move the first steps into the Alfresco Application Development Framework, the Getting Started dashboard is for sure a good starting point. The collection of descriptions and tutorials is what you should read, to start using the Angular 2 components. Indeed, after completed the journey into the initial samples, you could want to move your first steps alone, starting to develop something by yourself, very simple at the beginning, but concrete with clear use cases and goals in terms of features.
With this goal in mind, the Alfresco ADF examples have been developed. The Alfresco ADF examples are built as a unique GitHub project, containing a collection of simple (and less simple) projects developed using the Alfresco Application Developer Framework.
Why 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 artefacts. 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.
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-examplewill 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. The GitHub project is not the right place to ask (and receive) support because exists a better place for it: Gitter chat.
Feel free to ask there.
