You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 14, 2025. It is now read-only.
# Spring Cloud Data Flow Dashboard [](http://waffle.io/spring-cloud/spring-cloud-dataflow-ui)[](http://waffle.io/spring-cloud/spring-cloud-dataflow-ui)
This is the *Spring Cloud Data Flow Dashboard* user interface (UI). The UI uses [Angular][]. Source code documentation is available at http://cloud.spring.io/spring-cloud-dataflow-ui/.
18
-
19
-
> The Git repository for the main *Spring Cloud Data Flow* project is at: https://github.com/spring-cloud/spring-cloud-dataflow
20
-
21
-
# Building the Module
22
-
23
-
Two build tool chains are supported. Primarily, the *Spring Cloud Data Flow UI* uses [npm][] ([Node.js][]-based) for managing dependencies and the execution of the build. In order to provide easier *Continuous Integration* (CI) support, [Maven][] can also be used to execute the build.
24
-
25
-
The *Spring Cloud Data Flow Dashboard* uses [Maven][], specifically the [frontend-maven-plugin][] which will actually execute [npm][] underneath. Using the [frontend-maven-plugin][], however, the required tooling, including [Node.js][] will be downloaded, installed and executed for you.
26
-
27
-
## Requirements
28
-
29
-
Using [Maven][] is also the easiest route for Java developers to get started, as the only requirements are:
This is the **Spring Cloud Data Flow Dashboard** user interface (UI). The UI uses [Angular][]. **Source code documentation** is available at http://cloud.spring.io/spring-cloud-dataflow-ui/.
49
+
50
+
> The Git repository for the main **Spring Cloud Data Flow** project is at: https://github.com/spring-cloud/spring-cloud-dataflow
51
+
52
+
---
53
+
54
+
## Showcase
55
+
56
+
<center>
57
+
<table>
58
+
<tr>
59
+
<td><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-available-apps-list.png"><img width="120" alt="Spring Cloud Data Flow" src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-available-apps-list.png"></a></td>
60
+
<td><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-bulk-import-applications.png"><img width="120" alt="Spring Cloud Data Flow" src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-bulk-import-applications.png"></a></td>
61
+
<td><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-streams-list-definitions.png"><img width="120" alt="Spring Cloud Data Flow" src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-streams-list-definitions.png"></a></td>
62
+
<td><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-flo-create-stream.png"><img width="120" alt="Spring Cloud Data Flow" src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-flo-create-stream.png"></a></td>
63
+
</tr>
64
+
<tr>
65
+
<td><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-stream-deploy-builder.png"><img width="120" alt="Spring Cloud Data Flow" src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-stream-deploy-builder.png"></a></td>
66
+
<td><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-task-apps-list.png"><img width="120" alt="Spring Cloud Data Flow" src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-task-apps-list.png"></a></td>
67
+
<td><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-ctr-flo-tab.png"><img width="120" alt="Spring Cloud Data Flow" src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-ctr-flo-tab.png"></a></td>
68
+
<td><a href="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-jobs-job-execution-details.png"><img width="120" alt="Spring Cloud Data Flow" src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/master/spring-cloud-dataflow-docs/src/main/asciidoc/images/dataflow-jobs-job-execution-details.png"></a></td>
69
+
</tr>
70
+
</table>
71
+
</center>
72
+
73
+
---
74
+
75
+
## How To Use
76
+
77
+
Two build tool chains are supported. Primarily, the **Spring Cloud Data Flow UI** uses [npm][] ([Node.js][]-based) for managing dependencies and the execution of the build. In order to provide easier **Continuous Integration** (CI) support, [Maven][] can also be used to execute the build.
78
+
79
+
The **Spring Cloud Data Flow Dashboard** uses [Maven][], specifically the [frontend-maven-plugin][] which will actually execute [npm][] underneath. Using the [frontend-maven-plugin][], however, the required tooling, including [Node.js][] will be downloaded, installed and executed for you.
80
+
81
+
### Building the Project using Maven
82
+
83
+
Please ensure that at a minimum [Maven][] and [Git][] are available on your system (Using [Maven][] is also the easiest route for Java developers to get started).
This will create `target/spring-cloud-dataflow-ui-1.3.0.BUILD-SNAPSHOT.jar` and also install the build artifact into the local Maven repository.
41
90
42
-
## Building the Project using npm
91
+
###Building the Project using npm
43
92
44
93
For UI development purposes, we recommend using [npm][] directly. Please ensure that at a minimum [Node.js][], [npm][] and the [Angular CLI][] are available on your system. In order to execute the build simply do:
45
94
@@ -48,151 +97,26 @@ For UI development purposes, we recommend using [npm][] directly. Please ensure
48
97
$ npm install
49
98
$ ng build --prod
50
99
51
-
**NOTE:** Before building be sure that the `ng-serve` development server has been shutdown.
52
-
53
-
### Build fails after merging a branch or changing branches
54
-
55
-
In some cases the npm-modules or other dependencies may become inconsistent during branch changes.
56
-
In order to resolve the problem we need to clean out inconsistent dependencies.
57
-
The following instructions can be used to do this:
58
-
59
-
* Shutdown the development server if it is running.
60
-
* Commit or stash your changes
61
-
* Execute the following:
62
-
* `git clean -fx`
63
-
* `npm install`
64
-
* If you stashed your files execute the following: `git stash pop`
65
-
* Now build the application by executing the following: `ng build --prod`
66
-
67
-
## Important Build-related Configuration Files
68
-
69
-
***pom.xml** Maven config file
70
-
* ui/**package.json** Node dependencies
71
-
72
-
# Running Tests - Locally
73
-
74
-
## Unit Tests
75
-
76
-
```bash
77
-
$ ng test --single-run
78
-
```
79
-
80
-
## E2E Tests
81
-
82
-
```bash
83
-
$ npm run e2e
84
-
```
85
-
86
-
# Running Tests - SauceLabs
87
-
88
-
Before you can run tests using SauceLabs, please setup your username and password:
89
-
90
-
```bash
91
-
$ export SAUCE_USERNAME=your-username
92
-
$ export SAUCE_ACCESS_KEY=your-access-key
93
-
```
94
-
95
-
## Unit Tests
96
-
97
-
```bash
98
-
$ npm run test-saucelabs-local
99
-
```
100
-
101
-
## E2E Tests
102
-
103
-
For E2E tests, developers should refrain from using `localhost`. Instead, add `dataflow.local` to your local DNS hosts file.
104
-
105
-
```bash
106
-
$ npm run e2e-saucelabs-local
107
-
```
108
-
109
-
## Slow Internet Connection
100
+
Before building be sure that the `ng-serve` development server has been shutdown.<br >
110
101
111
-
By default the tests use an embedded version of Sauce Connect. In case you enounter test failures due to bandwidth constraints,
112
-
you may consider establishing a SauceLabs tunnel using the stand-alone **[Sauce Connect](https://wiki.saucelabs.com/display/DOCS/Sauce+Connect+Proxy)**.
102
+
**If you want to contribute and help developing the project, please, have a look at the [Developer Guideline](README_DEV.md/#development).**
113
103
114
-
Setup instructions can be found [here](https://wiki.saucelabs.com/display/DOCS/Basic+Sauce+Connect+Proxy+Setup).
104
+
---
115
105
116
-
Make sure you have at least the following environment variables defined:
106
+
## Acknowledgments
117
107
118
-
export SAUCE_CONNECT_USE_EMBEDDED=false
119
-
export SAUCE_USER=
120
-
export SAUCE_API_KEY=
108
+
Thanks to [Saucelabs](https://saucelabs.com/) and [Browserstack](https://www.browserstack.com/) for supporting us.
109
+
This project uses code from several open source packages:
0 commit comments