diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index f87dd47ec27..8c972237bb4 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -10,6 +10,7 @@ Please ask before on our gitter channel https://gitter.im/Alfresco/alfresco-ng2- - [ ] New feature request - [ ] Bug - [ ] Support request +- [ ] Documentation ``` **Current behavior:** diff --git a/.travis.yml b/.travis.yml index 1e14c4ce252..e15bf35b9ca 100644 --- a/.travis.yml +++ b/.travis.yml @@ -32,24 +32,31 @@ env: before_script: - if ([ "$MODULE" != "ng2-alfresco-core" ]); then - (cd ng2-components/ng2-alfresco-core; if [ ! -d "dist" ]; then npm install; fi; npm link); + (cd ng2-components/ng2-alfresco-core; if [ ! -d "bundles" ]; then npm link; fi); fi - if ([ "$MODULE" == "ng2-alfresco-documentlist" ] || [ "$MODULE" == "ng2-alfresco-webscript" ] || [ "$MODULE" == "ng2-activiti-processlist" ] || [ "$MODULE" == "ng2-activiti-tasklist" ]); then - (cd ng2-components/ng2-alfresco-datatable; npm link ng2-alfresco-core; if [ ! -d "dist" ]; then npm install; fi; npm link); + (cd ng2-components/ng2-alfresco-datatable; npm link ng2-alfresco-core; if [ ! -d "bundles" ]; then npm link; fi); fi - if ([ "$MODULE" == "ng2-activiti-tasklist" ] || [ "$MODULE" == "ng2-activiti-processlist" ]); then - (cd ng2-components/ng2-activiti-form; npm link ng2-alfresco-core; if [ ! -d "dist" ]; then npm install; fi; npm link); + (cd ng2-components/ng2-alfresco-datatable; npm link ng2-alfresco-core; if [ ! -d "bundles" ]; then npm link; fi); + (cd ng2-components/ng2-activiti-form; npm link ng2-alfresco-core; if [ ! -d "bundles" ]; then npm link; fi); fi - if ([ "$MODULE" == "ng2-activiti-processlist" ]); then - (cd ng2-components/ng2-activiti-tasklist; npm link ng2-alfresco-core; npm link ng2-alfresco-datatable; npm link ng2-activiti-form; if [ ! -d "dist" ]; then npm install; fi; npm link); + (cd ng2-components/ng2-alfresco-datatable; npm link ng2-alfresco-core; if [ ! -d "bundles" ]; then npm link; fi); + (cd ng2-components/ng2-activiti-form; npm link ng2-alfresco-core; if [ ! -d "bundles" ]; then npm link; fi); + (cd ng2-components/ng2-activiti-tasklist; npm link ng2-alfresco-core; npm link ng2-alfresco-datatable; npm link ng2-activiti-form; if [ ! -d "bundles" ]; then npm link; fi); fi - if ([ "$MODULE" == "ng2-activiti-analytics" ]); then - (cd ng2-components/ng2-activiti-diagrams; npm link ng2-alfresco-core; if [ ! -d "dist" ]; then npm install; fi; npm link); + (cd ng2-components/ng2-activiti-diagrams; npm link ng2-alfresco-core; if [ ! -d "bundles" ]; then npm link; fi); + fi + - if ([ "$MODULE" == "ng2-alfresco-search" ]); then + (cd ng2-components/ng2-alfresco-datatable; npm link ng2-alfresco-core; if [ ! -d "bundles" ]; then npm link; fi); + (cd ng2-components/ng2-alfresco-documentlist; npm link ng2-alfresco-core; npm link ng2-alfresco-datatable; if [ ! -d "bundles" ]; then npm link; fi); fi - cd ng2-components/$MODULE; - npm run travis; - - npm install; -script: npm run test +#npm insall run install, build and tests +script: npm install # Send coverage data to Coveralls after_success: bash <(curl -s https://codecov.io/bash) -X gcov diff --git a/.vscode/settings.json b/.vscode/settings.json index ee92513479d..30d10b67e52 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -6,6 +6,8 @@ "**/.hg": true, "**/.DS_Store": true, "**/*.js": { "when": "$(basename).ts"}, - "**/*.js.map": { "when": "$(basename)"} - } + "**/*.js.map": { "when": "$(basename)"}, + "**/*.d.ts": { "when": "$(basename).ts"} + }, + "editor.renderIndentGuides": true } diff --git a/README.md b/README.md index 78ddedf5904..e2c3265749c 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,12 @@ To view the complete list of all the components that you can use to build your c You can browse all the components at the following [page](http://devproducts.alfresco.com/). +## Demo Application + +A separate application showcasing integration of components can be found [here](https://github.com/Alfresco/alfresco-ng2-components/tree/master/demo-shell-ng2). + +You will find examples of basic interaction for both BPM and ECM sets of widgets. + ## Yeoman generators To speed up the development of your Alfresco Angular 2 application, or Alfresco Angular 2 component, use one of the Yeoman generators. diff --git a/appveyor.yml b/appveyor.yml index cefe10fbfd7..f328219a3fa 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,4 +1,9 @@ # Test against this version of Node.js +branches: + only: + - master + - development + - dev-build-test environment: nodejs_version: "5" @@ -25,22 +30,19 @@ install: # Get the latest stable version of Node.js or io.js - ps: Install-Product node $env:nodejs_version # install module - - IF %COMPONENT_NAME% NEQ ng2-alfresco-core (cd ng2-components/ng2-alfresco-core && npm install && npm link && cd ../../) - - IF %COMPONENT_NAME% EQU ng2-alfresco-documentlist (cd ng2-components/ng2-alfresco-datatable && npm link ng2-alfresco-core && npm install && npm link && cd ../../) - - IF %COMPONENT_NAME% EQU ng2-activiti-processlist (cd ng2-components/ng2-alfresco-datatable && npm link ng2-alfresco-core && npm install && npm link && cd ../../) - - IF %COMPONENT_NAME% EQU ng2-activiti-processlist (cd ng2-components/ng2-activiti-form && npm link ng2-alfresco-core && npm install && npm link && cd ../../) - - IF %COMPONENT_NAME% EQU ng2-activiti-processlist (cd ng2-components/ng2-activiti-tasklist && npm link ng2-alfresco-core && npm link ng2-alfresco-datatable && npm link ng2-activiti-form && npm install && npm link && cd ../../) - - IF %COMPONENT_NAME% EQU ng2-activiti-tasklist (cd ng2-components/ng2-alfresco-datatable && npm link ng2-alfresco-core && npm install && npm link && cd ../../) - - IF %COMPONENT_NAME% EQU ng2-activiti-tasklist (cd ng2-components/ng2-activiti-form && npm link ng2-alfresco-core && npm install && npm link && cd ../../) - - IF %COMPONENT_NAME% EQU ng2-alfresco-webscript (cd ng2-components/ng2-alfresco-datatable && npm link ng2-alfresco-core && npm install && npm link && cd ../../) - - IF %COMPONENT_NAME% EQU ng2-activiti-analytics (cd ng2-components/ng2-activiti-diagrams && npm link link ng2-alfresco-core && npm install && npm link && cd ../../) + - IF %COMPONENT_NAME% NEQ ng2-alfresco-core (cd ng2-components/ng2-alfresco-core && npm link && cd ../../) + - IF %COMPONENT_NAME% EQU ng2-alfresco-documentlist (cd ng2-components/ng2-alfresco-datatable && npm link ng2-alfresco-core && npm link && cd ../../) + - IF %COMPONENT_NAME% EQU ng2-alfresco-search (cd ng2-components/ng2-alfresco-datatable && npm link ng2-alfresco-core && npm link && cd ../../) + - IF %COMPONENT_NAME% EQU ng2-alfresco-search (cd ng2-components/ng2-alfresco-documentlist && npm link ng2-alfresco-core && npm link ng2-alfresco-datatable && npm link && cd ../../) + - IF %COMPONENT_NAME% EQU ng2-activiti-processlist (cd ng2-components/ng2-alfresco-datatable && npm link ng2-alfresco-core && npm link && cd ../../) + - IF %COMPONENT_NAME% EQU ng2-activiti-processlist (cd ng2-components/ng2-activiti-form && npm link ng2-alfresco-core && npm link && cd ../../) + - IF %COMPONENT_NAME% EQU ng2-activiti-processlist (cd ng2-components/ng2-activiti-tasklist && npm link ng2-alfresco-core && npm link ng2-alfresco-datatable && npm link ng2-activiti-form && npm link && cd ../../) + - IF %COMPONENT_NAME% EQU ng2-activiti-tasklist (cd ng2-components/ng2-alfresco-datatable && npm link ng2-alfresco-core && npm link && cd ../../) + - IF %COMPONENT_NAME% EQU ng2-activiti-tasklist (cd ng2-components/ng2-activiti-form && npm link ng2-alfresco-core && npm link && cd ../../) + - IF %COMPONENT_NAME% EQU ng2-alfresco-webscript (cd ng2-components/ng2-alfresco-datatable && npm link ng2-alfresco-core && npm link && cd ../../) + - IF %COMPONENT_NAME% EQU ng2-activiti-analytics (cd ng2-components/ng2-activiti-diagrams && npm link link ng2-alfresco-core && npm link && cd ../../) - cd ng2-components/%COMPONENT_NAME% - - IF %COMPONENT_NAME% NEQ ng2-alfresco-core (npm link ng2-alfresco-core) - - IF %COMPONENT_NAME% EQU ng2-alfresco-documentlist (npm link ng2-alfresco-datatable) - - IF %COMPONENT_NAME% EQU ng2-activiti-processlist (npm link ng2-alfresco-datatable && npm link ng2-activiti-form && npm link ng2-activiti-tasklist) - - IF %COMPONENT_NAME% EQU ng2-activiti-tasklist (npm link ng2-alfresco-datatable && npm link ng2-activiti-form) - - IF %COMPONENT_NAME% EQU ng2-alfresco-webscript (npm link ng2-alfresco-datatable) - - IF %COMPONENT_NAME% EQU ng2-activiti-analytics (npm link ng2-activiti-diagrams) + - npm run travis # Post-install test scripts. test_script: diff --git a/demo-shell-ng2/README.md b/demo-shell-ng2/README.md index 13db6efa47c..31136a7a7c4 100644 --- a/demo-shell-ng2/README.md +++ b/demo-shell-ng2/README.md @@ -12,9 +12,11 @@ ## Installing -To correctly use this demo check that on your machine is running Node version 6.9.2 LTS or higher. +To correctly use this demo check that on your machine is running [Node](https://nodejs.org/en/) version 6.9.2 LTS or higher. ```sh +git clone https://github.com/Alfresco/alfresco-ng2-components.git +cd alfresco-ng2-components/demo-shell-ng2/ npm install ``` @@ -28,22 +30,26 @@ This command compiles and starts the project in watch mode. Browser will automatically reload upon changes. Upon start you can navigate to `http://localhost:3000` with your preferred browser. +### Important notes + +This script is recommended for development environment and not suited for headless servers and network access. + ## Production build ```sh npm run build +npm run start:dist ``` This command builds broject in `production` mode. All output is placed to `dist` folder and can be served your preferred web server. You should need no additional files outside the `dist` folder. -In order to quickly test the output you can use the [wsrv](https://www.npmjs.com/package/wsrv) tool (lightweight web server): +### Important notes -```sh -npm install -g wsrv -wsrv -s -o dist/ -``` +By default demo application is configured to use [wsrv](https://www.npmjs.com/package/wsrv) tool (lightweight web server) +to serve production build output. It will be running at `0.0.0.0` address with port `3000` and allow you accessing your application +via network. However you can use any web server of your choice in production. ## Development branch build diff --git a/demo-shell-ng2/app/app.component.html b/demo-shell-ng2/app/app.component.html index 5ee422e46d3..aeee137ec91 100644 --- a/demo-shell-ng2/app/app.component.html +++ b/demo-shell-ng2/app/app.component.html @@ -1,6 +1,6 @@