Repository files navigation

An extension for the Yeoman generator to create minimal Alfresco ADF applications.

See the followingpage for an introduction to the Alfresco Application Development Framework.

Before you start using this development framework and the generator, make sure you have installed all required software and done all thenecessary configuration, see thispage.

Install the LTS (Long-Term Support) version of the Node.js:https://nodejs.org/en/download/

You can use the official macOS installer from thehttps://nodejs.org/en/download/ page, it includes the NPM as well.

Use this article to get details on how to install Node.js and NPM on Ubuntu:https://linuxize.com/post/how-to-install-node-js-on-ubuntu-20-04/

It is important to install the developer tools:

sudo apt install build-essential

Use this article to get details on how to install Node.js and NPM on CentOS:https://linuxize.com/post/how-to-install-node-js-on-centos-7/

It is important to install the developer tools:

sudo yum install gcc-c++ make

First, install theYeoman tool:

npm install -g yo

Use the following command to install the Alfresco App Generator for the Yeoman:

npm install -g generator-alfresco-adf-app

To install a specific version, use @ followed by the version.

npm install -g generator-alfresco-adf-app@WHERSION_YOU_WANT

Some tags in the project may not be available in npm.See available versions for npm

First, move in the folder where you want create your project.

yo alfresco-adf-app

You will need to run the following scripts in the generated folder:

npm installnpm start

Commands above install all project dependencies, start the project and watch for changes.

Alternatively you can use generator with install switch to trigger automatic installation of dependencies via npm install script:

yo alfresco-adf-app --install

For the projects running with Activiti 7 you need to update theapp.config.json with the list of the apps to use.

For example:

{"alfresco-deployed-apps" : [{"name":"simple-app"}]  }

For more information about the app list component refer to thedocumentation

You can use the generator in the unattended mode by providing all necessary options from the command line:

yo ng2-alfresco-app -n app2 -b adf-cli-aps-template -i

Options:

Default blueprint names:

• adf-cli-acs-aps-template
• adf-cli-acs-template
• adf-cli-aps-template

npm update -g generator-alfresco-adf-app

Show current version generator-alfresco-adf-app installed

npm ls -g generator-alfresco-adf-app

1. Fork it!
2. Create your feature branch:git checkout -b my-new-feature
3. Make some changes
4. Add the changes to the index:git add .
5. Commit your changes:git commit -m 'Add some feature'
6. Push to the branch:git push origin my-new-feature
7. Submit a pull request

To Contribute to the existing code base, add test cases to cover the new behaviour, and make sure all the existing tests are still green.

To test the generator:

npmtest

To scaffold app from local changes:

yo<cloned project path>

Example

yo ../generator-alfresco-adf-app# this generates from the local changes

In order to add a new blueprint just put the project template to theapp/templates folder.

Requirements for new projects:

• must containpackage.json file
• thepackage.json file must contain at leastname andversion attributes

# OS X / LinuxDEBUG=yeoman:generator yo alfresco-adf-app# Windowsset DEBUG=yeoman:generator& yo alfresco-adf-app

More ondebugging generators.

For detailed changelog, seeReleases.

Apache Version 2.0