Yeoman Generator Angular 2 Alfresco Application
JavaScript TypeScript HTML CSS
Latest commit 88c76dc Jan 30, 2017 @magemello magemello committed with VitoAlbano 1.1.0 (#60)
* #52 fix test config for webpack

* readme update

* #57 update to adf 1.1.0 (#58)

* change update js-api

* 1.1.0

README.md

Yeoman Generator Angular 2 Alfresco Application

yeoman logo

npm version Build Status Coverage Status downloads stats

Yeoman generator generating a Angular2 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-ng2-alfresco-app

Generating a new application project:

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

yo ng2-alfresco-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 ng2-alfresco-app --install

Optional utility commands

  • Link all ADF components locally
npm run link
  • Clean the project from node_modules and typings folder
npm run clean

start script also includes live reload and watchers for all the .ts files. TypeScript watchers are also configured for node_modules folder within demo shell and provide live reload for all the component libraries as well.

  • Install dependencies or reinstall after the clean
npm install

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

Debugging generator

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

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

More on debugging generators.

Advanced options

yo ng2-alfresco-app --alfresco

Typically used for internal purposes and adds the following extras to the generated project structure:

  • adds Alfresco license headers to all code files
  • configures component package.json with additional license checker configurations (devDependencies, scripts, etc.)

History

For detailed changelog, see Releases.

Contributors

Contributor GitHub profile Twitter profile
Eugenio Romano Eugenio Romano @RomanoEugenio
Denys Vuika Denys Vuika @denisvuyka
Mario Romano Mario Romano @MagemelloMario

See all contributors

License

Apache Version 2.0