Merge branch 'monoFrontendRepo'

docs/dev/RepositoryUI.md → docs/dev/TOSCA-Management.md

@@ -1,4 +1,4 @@
-# Repository: Angular UI
+# TOSCA Management UI
 
 In [Angular](angular.io), the project structure should be very flat. However, because we have a very complex and often nested
 system, this structure is also present in the angular app.
@@ -51,7 +51,7 @@ can be found in `org.eclipse.winery.repository.ui/dist/doc/index.html`. It is al
 
 ## License
 
-Copyright (c) 2017 Contributors to the Eclipse Foundation
+Copyright (c) 2017-2019 Contributors to the Eclipse Foundation
 
 See the NOTICE file(s) distributed with this work for additional
 information regarding copyright ownership.

docs/dev/config/IntelliJ IDEA/README.md

@@ -49,23 +49,6 @@ If this goes wrong at the first run, execute `mvn package -DskipTests` a second
     8. Go to Editor > Copyright
     9. Set "Winery" as Default project copyright
     10. Press "OK"
-5. Configure Non-Null annotations properly  
-   This is required for the [IntelliJ code inspections](https://www.jetbrains.com/help/idea/running-inspections.html) to run properly.
-    1. Open the Settings (by pressing <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>S</kbd>)
-    1. Search for "null"
-    1. Go to "Build, Execution, Deployment"
-    1. Go to "Compiler"
-    1. Click on "Configure annotations..."
-    1. At "Nullable annotations", click on the plus
-    1. Search for `org.eclipse.jdt.annotation.Nullable`  
-       ![](graphics/config-nullable-annotation.png)
-    1. Double click it
-    1. At "NotNull annotations", click on the plus.
-    1. Search for `org.eclipse.jdt.annotation.NonNull`  
-       ![](graphics/config-nonnull-annotation.png)
-    1. Double click it
-    1. Click OK
-    1. Click OK
 6. Setup Apache Tomcat
     1. Download Tomcat 9.0 from <https://tomcat.apache.org/download-90.cgi>.
        Choose "zip" (E.g., <http://mirror.synyx.de/apache/tomcat/tomcat-9/v9.0.7/bin/apache-tomcat-9.0.7.zip>).
@@ -87,17 +70,15 @@ If this goes wrong at the first run, execute `mvn package -DskipTests` a second
     1. Set `/winery` as application context:<br>
        ![](graphics/run-step12-set-winery-as-application-context.png)
     1. Click "Apply"
-6. Setup npm run for Repository UI
+6. Setup npm run for TOSCA Management UI
     1. ![](graphics/run-repositoryui-step1-add-npm-config.png)
     1. ![](graphics/run-repositoryui-step2-configure.png)
-6. Setup npm run for Topology modeler
+6. Setup npm run for Topologymodeler
     1. ![](graphics/run-topologymodeler-step1-add-npm-config.png)
     1. ![](graphics/run-topologymodeler-step2-configure.png)
-6. Setup npm run for BPMN4TOSCA modeler
+6. Setup npm run for Workflowmodeler (BPMN4TOSCA Modeler)
     1. ![](graphics/run-topologymodeler-step1-add-npm-config.png)
-    1. Choose `package.json` of "org.eclipse.winery.workflowmodeler"
-    1. Use `ng` as script
-    1. Use `serve` as arguments
+    1. ![](graphics/run-workflowmodeler-step2.png)
 6. Setup XSD validation for TOSCA files
     1. Open the Settings (by pressing <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>S</kbd>)
     1. Go to "Languages & Frameworks"
@@ -117,22 +98,14 @@ If this goes wrong at the first run, execute `mvn package -DskipTests` a second
     1. Click "OK"
     1. Click "OK"
 6. Optional: In case you do not want to have the live-update of Angular, you build the wars of the UI and then deploy as follows:
-    - External artifact `.../org.eclipse.winery.repository.ui/target/winery-ui.war` to `/`
-    - External artifact `.../org.eclipse.winery.workflowmodeler/target/winery-workflowmodeler.war` to `/winery-workflowmodeler`
-7. Get a JetBrains account and vote up following issues (at the right side, just click the thumbs-up next to "Voters". In case you don't see "Voters", reload the page):
-  - <https://youtrack.jetbrains.com/issue/IDEA-195076>
-  - <https://youtrack.jetbrains.com/issue/IDEA-147601>
-  - <https://youtrack.jetbrains.com/issue/IDEA-142591>
-  - <https://youtrack.jetbrains.com/issue/IDEA-176611>
-  - <https://youtrack.jetbrains.com/issue/IDEA-75437>
-  - <https://youtrack.jetbrains.com/issue/IDEA-159739>
-  - <https://youtrack.jetbrains.com/issue/IDEA-131223>
-8. Pros: Install the [Key Promoter X plugin](https://plugins.jetbrains.com/plugin/9792-key-promoter-x).
+    - External artifact `.../org.eclipse.winery.frontends/target/tosca-management.war` to `/`
+    - External artifact `.../org.eclipse.winery.frontends/target/topologymodeler.war` to `/winery-topology-modeler`
+    - External artifact `.../org.eclipse.winery.frontends/target/workflowmodeler.war` to `/winery-workflowmodeler`
 9. Run everything
   - Select "Winery - REST". Click on "Play" (the green rectangle)
-  - Select "Repository UI". Click on "Play"
-  - Select "Topolgoy Modeler". Click on "Play".
-  - Open "http://localhost:4200" in your browser.
+  - Select "TOSCA Mangement UI". Click on "Play"
+  - Select "Topolgoymodeler". Click on "Play".
+  - Open <http://localhost:4200> in your browser.
 10. Demonstration: Open winery-repository (AKA tosca-definitions) in IntelliJ  
     This ensures that you can work with the TOSCA files using the IDE.
     1. Go to File -> Open...
@@ -161,7 +134,7 @@ If this goes wrong at the first run, execute `mvn package -DskipTests` a second
 
 ## License
 
-Copyright (c) 2017-2018 Contributors to the Eclipse Foundation
+Copyright (c) 2017-2019 Contributors to the Eclipse Foundation
 
 See the NOTICE file(s) distributed with this work for additional
 information regarding copyright ownership.

docs/dev/index.md

@@ -16,10 +16,9 @@ This document provides an index to all development guidelines and background inf
 - [Property Handling](property-handling.md)
 - [Recommended Reading](recommended-reading.md)
 - [RepositoryLayout](RepositoryLayout.md) - documents the layout of the repository (stored as plain text files)
-- [RepositoryUI](RepositoryUI.md)
+- [TOSCA-Mangement UI](TOSCA-Management.md)
 - [REST](REST.md) - how Winery's REST API works
 - [ToolChain](ToolChain) - GitHub workflow
-- [Topology Modeler](topology-modeler.md)
 - [Trouble Shooting](troubleshootings.md)
 - [TOSCA](../tosca/) - notes on OASIS TOSCA
 

org.eclipse.winery.frontends/.gitignore

@@ -0,0 +1,8 @@
+dist/
+/node/
+node_modules/
+target/
+/app/tosca-management/src/assets/built-codeEdit15_1/
+
+*.iml
+/app/tosca-management/src/assets/licenses/

org.eclipse.winery.frontends/README.md

@@ -0,0 +1,22 @@
+# Winery Frontends
+
+This project bundles all frontend components in one monorepo.
+Currently, there are three components available: (i) the TOSCA Management, (ii) the Topologymodeler, (iii) the Workflowmodeler.
+
+## TOSCA Management
+
+The management UI to manage TOSCA Definitions and file artifacts.
+It is the default UI which is started when `ng serve` or `ng serve tosca-management` is called.
+
+However, to start the TOSCA Management UI, you can run `npm run start-tosca-management`.
+The UI is then available at <localhost:4200>.
+
+## Topologymodeler
+
+The Topologymodeler is a graph-based modeling tool to graphically model TOSCA Topologies.
+It can be run by executing the commands `npm run start-topologymodeler` or `ng serve topologymodeler`.
+
+## Workflowmodeler
+
+Similar to the Topologymodeler, the Workflowmodeler is a tool to graphically model BPMN4TOSCA workflows.
+It can be run by executing the commands `npm run start-workflowmodeler` or `ng serve workflowmodeler`.