Yeoman Generator Angular 2 Alfresco Application
Switch branches/tags
Clone or download
eromano 2.5.0 (#153)
* add custom event polyfill

* enable polyfills by default (#103)

* fix overlay viewer in templates (#104)

* [ADF-2125] Removed 'ng2-' from generator instructions (#105)

* [ADF-2125] Removed 'ng2-' from generator instructions

* [ADF-2125] Fixed link that was displayed badly

* [ADF-2125] Fixed small grammar and display glitches

* [ADF-2125] Fixed generator names

* fix style issues

* [ADF-2164] Add docker support to the generated app (#107)

* Add docker support to the generated app

* added the travis configuration for the DOCKER pipeline

* docker publish instructions

* fix docker target folder

* [ADF-2145] Add the app routes files in the generator 2 (#108)

* add route file

* fix module

* travis conf

* [hackathon] command line mode support (#106)

* command line mode support

* code cleanup

* update travis settings

* Update dependencies 2.1.0 (#109)

* update depenccies 2.1.0
* fix import pdfjs

* Adding schema validation (#111)

* [ADF-2293] loading spinner (#112)

* loading spinner

* fix install dependencies

* ignore file

* remove path mapping from tsconfig

* 2.2.0 update generator beta4 (#113)

2.2.0 update generator beta5

* bump version

* reduce docker image sizes (#114)

* 2.3.0-beta1 (#116)

* fix: BrowserAnimationsModule (#117)

* Update generator to use packages version 2.3.0-beta2 (#121)

* use adf- tag components name

* Update generator to use packages version 2.3.0-beta4 (#122)

* documentList fix viewchildren (#124)

* Update generator to use packages version 2.3.0-beta5 (#125)

* update cli (#123)

add dist build

* Update ADF packages version 2.3.0-beta10 (#132)

* Update ADF packages version 2.3.0-beta10

* add alfresco api mock

* fix test aps generators

* 2.3.0 update

* update cli 1.7.4 (#130)

* update cli 1.7.4

* remove old workaround for 1.6.x

* [ADF-2581] Sidenav added to all templates (#134)

* [ADF-2581] Sidenav added to templates

* [ADF-2581] testing file added to App Layout component

* [ADF-2581] BrowserAnimationsModule duplicated

* [ADF-2581] BrowserAnimationModule added

* [ADF-2581] removed duplicated module

* Update ADF packages version 2.4.0-beta2 (#137)

* Update dependencies (#140)

* update moment version in generated project

* update package dependencies

* add spacer for the toolbars (#142)

* fix login test (#146)

* use overlay layout for preview (#141)

* use overlay layout for preview

* fix modules import and document list test

* PreviewService import task details test

* 2.4.0 update version

* fix merge

* Angular 6 (#151)

* update libs and add package lock

* add misssing gitignore files

* upgrade ACS blueprint to Angular 6

* update test

* update travis config

* remove rxjs-compat

* fix lint error

* upgrade ACS+APS blueprint

* update test

* upgrade APS template

* remove rxjs-compat

* remove unused import

* disable faulty tests

* update tests

* 2.5.0 (#152)
Latest commit 318bfe5 Aug 14, 2018
Permalink
Failed to load latest commit information.
__tests__ 2.5.0 (#153) Aug 14, 2018
app 2.5.0 (#153) Aug 14, 2018
docs 2.1.0 (#110) Jan 26, 2018
scripts 2.2.0 (#115) Mar 5, 2018
.editorconfig 1️⃣ first commit Jun 7, 2016
.eslintrc rework generator from scratch Sep 19, 2017
.gitignore 2.5.0 (#153) Aug 14, 2018
.npmignore 1.6.0 (#89) Jun 29, 2017
.travis.yml 2.5.0 (#153) Aug 14, 2018
LICENSE update file documents list Jun 30, 2016
README.md 2.1.0 (#110) Jan 26, 2018
package-lock.json 2.5.0 (#153) Aug 14, 2018
package.json 2.5.0 (#153) Aug 14, 2018

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

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