From db34fd395d2ad1061d29ded517a6bd5e8380703e Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Fri, 22 Apr 2016 13:16:23 +0100 Subject: [PATCH 1/5] Configuration for live runner MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - demo shell requires ‘npm link’ for alfresco libraries - live reload for component libraries and shell changes --- demo-shell-ng2/package.json | 5 +---- demo-shell-ng2/tsconfig.json | 6 ------ 2 files changed, 1 insertion(+), 10 deletions(-) diff --git a/demo-shell-ng2/package.json b/demo-shell-ng2/package.json index e8bbbfdbcc..100b11df61 100644 --- a/demo-shell-ng2/package.json +++ b/demo-shell-ng2/package.json @@ -11,8 +11,7 @@ "tsc:w": "tsc -w", "lite": "lite-server", "typings": "typings", - "postinstall": "typings install", - "build": "tsc -p .; exit 0" + "postinstall": "typings install" }, "license": "ISC", "dependencies": { @@ -22,8 +21,6 @@ "font-awesome": "^4.5.0", "jquery": "^2.2.2", "material-design-lite": "^1.1.3", - "ng2-alfresco-documentlist": "file:../ng2-components/ng2-alfresco-documentlist", - "ng2-alfresco-login": "file:../ng2-components/ng2-alfresco-login", "ng2-uploader": "denisvuyka/ng2-uploader", "reflect-metadata": "0.1.2", "rxjs": "5.0.0-beta.2", diff --git a/demo-shell-ng2/tsconfig.json b/demo-shell-ng2/tsconfig.json index a9ba2d14f1..9be71e4c6e 100644 --- a/demo-shell-ng2/tsconfig.json +++ b/demo-shell-ng2/tsconfig.json @@ -1,7 +1,6 @@ { "compilerOptions": { "target": "es5", - "outDir": "dist/app", "module": "system", "moduleResolution": "node", "sourceMap": true, @@ -10,11 +9,6 @@ "removeComments": false, "noImplicitAny": false }, - "files": [ - "node_modules/angular2/typings/browser.d.ts", - "typings/browser/ambient/jasmine/index.d.ts", - "app/**/*.ts" - ], "exclude": [ "node_modules", "typings/main", From 56b7a361cec6fbbc5763db7d5f93e1fcb75e32b6 Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Fri, 22 Apr 2016 14:07:10 +0100 Subject: [PATCH 2/5] support for both gulp and npm/tsc runners --- demo-shell-ng2/gulpfile.js | 13 +++++++++++-- demo-shell-ng2/package.json | 2 +- demo-shell-ng2/tsconfig.dev.json | 18 ++++++++++++++++++ demo-shell-ng2/tsconfig.json | 6 ++++++ 4 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 demo-shell-ng2/tsconfig.dev.json diff --git a/demo-shell-ng2/gulpfile.js b/demo-shell-ng2/gulpfile.js index dc4018ed2a..674cab02ee 100644 --- a/demo-shell-ng2/gulpfile.js +++ b/demo-shell-ng2/gulpfile.js @@ -25,7 +25,16 @@ gulp.task('copy:assets', ['clean'], function() { // copy dependencies gulp.task('copy:libs', ['clean'], function() { return gulp.src([ - 'node_modules/**/*' + 'node_modules/**/*', + '!node_modules/ng2-alfresco-*{,/**/*}' + ]) + .pipe(gulp.dest('dist/node_modules')) +}); + +gulp.task('copy:components', ['clean'], function() { + return gulp.src([ + '../ng2-components/**/*', + '!../ng2-components/README.md' ]) .pipe(gulp.dest('dist/node_modules')) }); @@ -75,7 +84,7 @@ gulp.task('serve', ['build'], function() { gulp.watch(['app/**/*', 'index.html'], ['buildAndReload']); }); -gulp.task('build', ['tslint', 'copy:assets', 'copy:libs', 'copy:typings', 'compile']); +gulp.task('build', ['tslint', 'copy:assets', 'copy:libs', 'copy:components', 'copy:typings', 'compile']); gulp.task('dev', ['build', 'serve'], reload); gulp.task('default', ['build']); gulp.task('buildAndReload', ['build'], reload); diff --git a/demo-shell-ng2/package.json b/demo-shell-ng2/package.json index 100b11df61..dfc9a48485 100644 --- a/demo-shell-ng2/package.json +++ b/demo-shell-ng2/package.json @@ -8,7 +8,7 @@ "start": "concurrently \"npm run tsc:w\" \"npm run lite\" ", "test": "live-server --open=tests-runner.html", "tsc": "tsc", - "tsc:w": "tsc -w", + "tsc:w": "tsc -w -p tsconfig.dev.json", "lite": "lite-server", "typings": "typings", "postinstall": "typings install" diff --git a/demo-shell-ng2/tsconfig.dev.json b/demo-shell-ng2/tsconfig.dev.json new file mode 100644 index 0000000000..0cd78ac35d --- /dev/null +++ b/demo-shell-ng2/tsconfig.dev.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "target": "es5", + "module": "system", + "moduleResolution": "node", + "sourceMap": true, + "emitDecoratorMetadata": true, + "experimentalDecorators": true, + "removeComments": false, + "noImplicitAny": false + }, + "exclude": [ + "dist", + "node_modules", + "typings/main", + "typings/main.d.ts" + ] +} diff --git a/demo-shell-ng2/tsconfig.json b/demo-shell-ng2/tsconfig.json index 9be71e4c6e..a9ba2d14f1 100644 --- a/demo-shell-ng2/tsconfig.json +++ b/demo-shell-ng2/tsconfig.json @@ -1,6 +1,7 @@ { "compilerOptions": { "target": "es5", + "outDir": "dist/app", "module": "system", "moduleResolution": "node", "sourceMap": true, @@ -9,6 +10,11 @@ "removeComments": false, "noImplicitAny": false }, + "files": [ + "node_modules/angular2/typings/browser.d.ts", + "typings/browser/ambient/jasmine/index.d.ts", + "app/**/*.ts" + ], "exclude": [ "node_modules", "typings/main", From 96fbccc706664754a1ff89ac19066a7d9d6f536b Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Fri, 22 Apr 2016 14:21:01 +0100 Subject: [PATCH 3/5] Readme updates --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 006a35719b..41188bdb44 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,57 @@ # ALFRESCO WEB COMPONENTS -### Running demo project +### Configuring development environment + +Get a copy ```sh git clone https://github.com/Alfresco/dev-platform-webcomponents.git +``` + +Install symlinks for Alfresco components + +*ng2-alfresco-documentlist component:* + +```sh +cd ng2-components/ng2-alfresco-documentlist +npm link +cd ../../demo-shell-ng +npm link ng2-alfresco-documentlist +``` + +*ng2-alfresco-login component:* + +```sh +cd ng2-components/ng2-alfresco-login +npm link +cd ../../demo-shell-ng +npm link ng2-alfresco-login +``` + +### Building and running + +**Install dependencies:** + + +```sh cd dev-platform-webcomponents/demo-shell-ng2/ npm install +``` + +**Build and watch with Gulp:** + +```sh npm run build.dev ``` + +*or* + +```sh +gulp dev +``` + +**Fast build and watch for dev purposes:** + +```sh +npm start +``` From 6d6c74505a04edef5bf2f3491ddaedf88711cd10 Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Fri, 22 Apr 2016 14:30:54 +0100 Subject: [PATCH 4/5] README updates --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 41188bdb44..3e37d9e5a2 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ ### Configuring development environment -Get a copy +**Get a copy** ```sh git clone https://github.com/Alfresco/dev-platform-webcomponents.git ``` -Install symlinks for Alfresco components +**Install symlinks for Alfresco components** *ng2-alfresco-documentlist component:* @@ -28,6 +28,8 @@ cd ../../demo-shell-ng npm link ng2-alfresco-login ``` +Please refer to [this article](https://docs.npmjs.com/cli/link) for more details on npm link. + ### Building and running **Install dependencies:** From c4070c6b8a4377b0d0d143c9c3a601f96d2dce74 Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Fri, 22 Apr 2016 19:36:53 +0100 Subject: [PATCH 5/5] Quick run script - quick run shell script (for demo setups) - README updates --- README.md | 40 +++++++++++++++++++++++++++++++++------- start.sh | 7 +++++++ 2 files changed, 40 insertions(+), 7 deletions(-) create mode 100755 start.sh diff --git a/README.md b/README.md index 3e37d9e5a2..7ebe70ac0a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,31 @@ # ALFRESCO WEB COMPONENTS +### Running demo project + +**Note**: *Steps below show the quickest way to get demo shell up and running. +For development configuration please refer to* **Configuring development environment** +*section further in this document.* + +##### Using setup script (recommended) + +```sh +git clone https://github.com/Alfresco/dev-platform-webcomponents.git +./start.sh +``` + +##### Manual setup + +```sh +git clone https://github.com/Alfresco/dev-platform-webcomponents.git +cd dev-platform-webcomponents/demo-shell-ng2 + +npm install +npm install ../ng2-components/ng2-alfresco-documentlist +npm install ../ng2-components/ng2-alfresco-login + +npm run build.dev +``` + ### Configuring development environment **Get a copy** @@ -40,7 +66,13 @@ cd dev-platform-webcomponents/demo-shell-ng2/ npm install ``` -**Build and watch with Gulp:** +**(Option 1) Fast build and watch for dev purposes:** + +```sh +npm start +``` + +**(Option 2) Build and watch with Gulp:** ```sh npm run build.dev @@ -51,9 +83,3 @@ npm run build.dev ```sh gulp dev ``` - -**Fast build and watch for dev purposes:** - -```sh -npm start -``` diff --git a/start.sh b/start.sh new file mode 100755 index 0000000000..3078965dcf --- /dev/null +++ b/start.sh @@ -0,0 +1,7 @@ +cd demo-shell-ng2 + +npm install +npm install ../ng2-components/ng2-alfresco-documentlist +npm install ../ng2-components/ng2-alfresco-login + +npm run build.dev