Skip to content
Yeoman Generator Angular 2 Alfresco Application
TypeScript HTML JavaScript Shell CSS Dockerfile
Branch: development
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__ [ADF-4030] Update ADF packages version 3.0.0 (#179) Feb 13, 2019
app bump 3.5.0 Sep 30, 2019
docs 2.1.0 (#110) Jan 26, 2018
e2e Update viewer page for e2e Jul 29, 2019
scripts Remove unused stuff Sep 18, 2019
.editorconfig 1️⃣ first commit Jun 7, 2016
.eslintrc rework generator from scratch Sep 19, 2017
.gitignore Enable SSO login in e2e tests for cloud templates (#186) (#188) Feb 26, 2019
.npmignore 1.6.0 (#89) Jun 29, 2017
.travis.yml Improve travis pt. 4 Sep 19, 2019
LICENSE update file documents list Jun 30, 2016
README.md
package-lock.json Downgrade puppeteer to v1.17.0 Sep 18, 2019
package.json bump 3.5.0 Sep 30, 2019
protractor.conf.js Fix Chrome in pipeline pt. 2 Sep 18, 2019
tsconfig.json automation test viewer (#168) Feb 13, 2019

README.md

ADF application generator for Yeoman

npm Build Status

Yeoman generator generating a ADF Angular Alfresco App scaffold

Introduction

See the following page for an introduction to the Alfresco Application Development Framework.

Prerequisites

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.

Installing Yeoman and the App Generator

First, install Yeoman:

npm install -g yo

Then the Alfresco Application Generator:

npm install -g generator-alfresco-adf-app

Generating a new application project

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 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:

yo alfresco-adf-app --install

Activiti 7

If you are generating a project for activiti7 you need to add in the app.config.json the list of the apps that you desire to use.

For example :

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

For more information about the app list component refer to the documentation

Using from the command line

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:

Name Alias Type Description
--name=<value> -n <value> string Application name
--blueprint=<value> -b <value> string Blueprint name
--install -i boolean Install dependencies upon generation

Default blueprint names:

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

Updating generator

npm update -g generator-alfresco-adf-app

Getting current version

  • Show current version generator-alfresco-adf-app installed
yo alfresco-adf-app --version

Contributing to the generator

  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:

npm test

Extending the blueprints

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 file
  • the package.json file must contain at least name and version attributes

Debugging generator

# OS X / Linux
DEBUG=yeoman:generator yo alfresco-adf-app

# Windows
set DEBUG=yeoman:generator & yo alfresco-adf-app

More on debugging generators.

History

For detailed changelog, see Releases.

License

Apache Version 2.0

You can’t perform that action at this time.