diff options
Diffstat (limited to 'sdc-workflow-designer-ui/README.md')
| -rw-r--r-- | sdc-workflow-designer-ui/README.md | 59 |
1 files changed, 44 insertions, 15 deletions
diff --git a/sdc-workflow-designer-ui/README.md b/sdc-workflow-designer-ui/README.md index 03f57b77..88859be5 100644 --- a/sdc-workflow-designer-ui/README.md +++ b/sdc-workflow-designer-ui/README.md @@ -1,28 +1,57 @@ -# Workflow designer -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.3.1. +# Workflow Modeler -## Development server +This project is an implementation of a workflow modeler for creating and maintaining [TOSCA] compatible management plans. -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. +It is based on the thesis [Ein Modellierungswerkzeug für BPMN4TOSCA] by Thomas Michelbach. -## Code scaffolding +## Installation -Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. + Fetch dependencies using `npm install` -## Build +## Run -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build. +Execute `npm start`. +Open <http://localhost:9527/> with correct HTTP GET params: -## Running unit tests +repositoryURL (e.g. http://dev.winery.opentosca.org/winery/) +namespace (e.g. http://www.example.org/ServiceTemplates) +id (e.g. PlanDemonstration) +plan (e.g. Test) -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). +You can also directly embed it into Winery. +Ensure that `winery.properties` contains following line. -## Running end-to-end tests +``` +bpmn4toscamodelerBaseURI=http://localhost:9527/ +``` -Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/). -Before running the tests make sure you are serving the app via `ng serve`. +## License +Copyright (c) 2017 ZTE Corporation. -## Further help +All rights reserved. This program and the accompanying materials +are made available under the terms of the [Eclipse Public License v1.0] +and the [Apache License v2.0] which both accompany this distribution, +and are available at http://www.eclipse.org/legal/epl-v10.html +and http://www.apache.org/licenses/LICENSE-2.0. -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md). +Please check the [EPL FAQ](https://eclipse.org/legal/eplfaq.php#DUALLIC) for implications. + + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html + + +## Literature + +### About TOSCA +* Binz, T., Breiter, G., Leymann, F., Spatzier, T.: Portable Cloud Services Using TOSCA. IEEE Internet Computing 16(03), 80--85 (May 2012). [DOI:10.1109/MIC.2012.43] +* Topology and Orchestration Specification for Cloud Applications Version 1.0. 25 November 2013. OASIS Standard. http://docs.oasis-open.org/tosca/TOSCA/v1.0/os/TOSCA-v1.0-os.html +* OASIS: Topology and Orchestration Specification for Cloud Applications (TOSCA) Primer Version 1.0 (2013) + +See http://www.opentosca.org/#publications for a list of publications in the OpenTOSCA ecosystem. + + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [DOI:10.1109/MIC.2012.43]: http://dx.doi.org/10.1109/MIC.2012.43 + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html + [Ein Modellierungswerkzeug für BPMN4TOSCA]: http://elib.uni-stuttgart.de/opus/volltexte/2015/9943/ + [TOSCA]: https://www.oasis-open.org/committees/tosca/ |