ADF application generator for Yeoman
npm install generator-alfresco-adf-appAn extension for the Yeoman generator to create minimal Alfresco ADF applications.
See the following page 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 the
necessary configuration, see this page.
Install the LTS (Long-Term Support) version of the Node.js:
You can use the official macOS installer from the
Use this article to get details on how to install Node.js and NPM on Ubuntu:
It is important to install the developer tools:
``sh`
sudo apt install build-essential
Use this article to get details on how to install Node.js and NPM on CentOS:
It is important to install the developer tools:
`sh`
sudo yum install gcc-c++ make
First, install the Yeoman tool:
`sh`
npm install -g yo
Use the following command to install the Alfresco App Generator for the Yeoman:
`sh`
npm install -g generator-alfresco-adf-app
To install a specific version, use @ followed by the version.
`sh`
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.
`sh`
yo alfresco-adf-app
You will need to run the following scripts in the generated folder:
`sh`
npm install
npm 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:
`sh`
yo alfresco-adf-app --install
For the projects running with Activiti 7 you need to update the app.config.json with the list of the apps to use.
For example:
`json`
{
"alfresco-deployed-apps" : [{"name": "simple-app"}]
}
For more information about the app list component refer to the documentation
You can use the generator in the unattended mode by providing all necessary options from the command line:
`sh`
yo ng2-alfresco-app -n app2 -b adf-cli-aps-template -i
Options:
| Name | Alias | Type | Description |
| --- | --- | --- | --- |
| --name=\
| --blueprint=\
| --install | -i | boolean | Install dependencies upon generation |
Default blueprint names:
- adf-cli-acs-aps-template
- adf-cli-acs-template
- adf-cli-aps-template
`sh`
npm update -g generator-alfresco-adf-app
Show current version generator-alfresco-adf-app installed
`sh`
npm ls -g generator-alfresco-adf-app
1. Fork it!
2. Create your feature branch: git checkout -b my-new-featuregit add .
3. Make some changes
4. Add the changes to the index: git commit -m 'Add some feature'
5. Commit your changes: git push origin my-new-feature
6. Push to the branch:
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:
`sh`
npm test
To scaffold app from local changes:
`sh`
yo
Example
`sh`
yo ../generator-alfresco-adf-app # this generates from the local changes
In order to add a new blueprint just put the project template to the app/templates folder.
Requirements for new projects:
- must contain package.json filepackage.json
- the file must contain at least name and version attributes
`shOS X / Linux
DEBUG=yeoman:generator yo alfresco-adf-app
More on debugging generators.
For detailed changelog, see Releases.