Skip to content

Working with the development branch

Eugenio Romano edited this page Mar 20, 2018 · 6 revisions

This page is a guide to help you use the development branch.

Anatomy of the project

Name Description
📁 demo-shell Demo project mainly used to test components
📁 lib Components folder. All the ADF components are here
📁 scripts Scripts that will help you develop ADF - [go to this page for more information]

Development branch

In order to develop new features or fix bugs you need to create a new branch starting from the Development branch. For more information about the Branching Strategy refer to this page

Build the Components

The ng2-components are strictly related to the alfresco-js-api. To understand the relationship between these two projects please refer to this page.

To build the ng2-components using the development branch of the alfresco-js-api you can use the following script present in the scripts folder:

./npm-build-all.sh -gitjsapi development

This script inside npm-build-all.sh installs the node_modules necessary to build all the components using the development version of the alfresco-js-api. For more details about all the possible options available with npm-build-all.sh please refer to this readme:

Build single component

You can also build a single component. In order to build it perform the below :

cd ng2-components/ng2-[COMPONENT_TO_BUILD]
npm install
npm run build

Test the components

To run the tests on all the ng2-components using the development branch of the alfresco-js-api you can use the following script present in the scripts folder:

./npm-build-all.sh -t -gitjsapi development

Test single component

You can also test a single component. In order to build it perform the below :

./npm-build-all.sh -t "COMPONENT_NAME" -gitjsapi development

Start the demo-shell

To run the demo-shell using the development branch of the alfresco-js-api you can use the following script present in the scripts folder:

./start.sh -dev -gitjsapi development