|
| 1 | +# Spring Cloud Dataflow UI |
1 | 2 |
|
2 | | -<p align="center"> |
3 | | - <a href="https://dataflow.spring.io/"> |
4 | | - <img alt="Spring Data Flow Dashboard" title="Spring Data Flow Dashboard" src="https://i.imgur.com/MGLL6qG.png" width="450"> |
5 | | - </a> |
6 | | -</p> |
| 3 | +> [!WARNING] |
| 4 | +> The 3.4.x branch is out of OSS support |
7 | 5 |
|
8 | | -<p align="center"> |
9 | | - <a href="https://travis-ci.org/spring-cloud/spring-cloud-dataflow-ui"> |
10 | | - <img src="https://travis-ci.org/spring-cloud/spring-cloud-dataflow-ui.png?branch=master" |
11 | | - alt="Build Status"> |
12 | | - </a> |
13 | | - <a href="https://ci.appveyor.com/project/ghillert/spring-cloud-dataflow-ui/branch/master"> |
14 | | - <img src="https://ci.appveyor.com/api/projects/status/7pqco2aqjyaphp36/branch/master?svg=true" |
15 | | - alt="Build status"> |
16 | | - </a> |
17 | | - <a href="https://codecov.io/gh/spring-cloud/spring-cloud-dataflow-ui/branch/master"> |
18 | | - <img src="https://codecov.io/gh/spring-cloud/spring-cloud-dataflow-ui/branch/master/graph/badge.svg" |
19 | | - alt="Code Coverage"> |
20 | | - </a> |
21 | | - <a href="https://saucelabs.com/u/ghillert"> |
22 | | - <img src="https://saucelabs.com/buildstatus/ghillert" |
23 | | - alt="Sauce Test Status"> |
24 | | - </a> |
25 | | -</p> |
26 | | - |
27 | | -<p align="center"> |
28 | | - <a href="#introduction">Introduction</a> • |
29 | | - <a href="#how-to-use">How To Use</a> • |
30 | | - <a href="#acknowledgments">Acknowledgments</a> |
31 | | -</p> |
32 | | - |
33 | | -## Introduction |
34 | | - |
35 | | -This is the **Spring Cloud Data Flow Dashboard** user interface (UI). The UI uses [Angular][]. **Source code documentation** is available at https://cloud.spring.io/spring-cloud-dataflow-ui/. |
36 | | - |
37 | | -> The Git repository for the main **Spring Cloud Data Flow** project is at: https://github.com/spring-cloud/spring-cloud-dataflow |
38 | | -
|
39 | | ---- |
40 | | - |
41 | | -## Showcase |
42 | | - |
43 | | -<center> |
44 | | - <table> |
45 | | - <tr> |
46 | | - <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> |
47 | | - <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> |
48 | | - <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> |
49 | | - <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> |
50 | | - </tr> |
51 | | - <tr> |
52 | | - <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> |
53 | | - <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> |
54 | | - <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> |
55 | | - <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> |
56 | | - </tr> |
57 | | - </table> |
58 | | -</center> |
59 | | - |
60 | | ---- |
61 | | - |
62 | | -## How To Use |
63 | | - |
64 | | -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. |
65 | | - |
66 | | -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. |
67 | | - |
68 | | -### Building the Project using Maven |
69 | | - |
70 | | -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). |
71 | | - |
72 | | - $ git clone https://github.com/spring-cloud/spring-cloud-dataflow-ui.git |
73 | | - $ cd spring-cloud-dataflow-ui |
74 | | - $ mvn clean install |
75 | | - |
76 | | -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. |
77 | | - |
78 | | -### Building the Project using npm |
79 | | - |
80 | | -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: |
81 | | - |
82 | | - $ git clone https://github.com/spring-cloud/spring-cloud-dataflow-ui.git |
83 | | - $ cd spring-cloud-dataflow-ui/ui |
84 | | - $ npm install |
85 | | - $ ng build --prod |
86 | | - |
87 | | -Before building be sure that the `ng-serve` development server has been shutdown.<br > |
88 | | - |
89 | | -**If you want to contribute and help developing the project, please, have a look at the [Developer Guideline](README_DEV.md/#development).** |
90 | | - |
91 | | ---- |
92 | | - |
93 | | -## Acknowledgments |
94 | | - |
95 | | -Thanks to [Saucelabs](https://saucelabs.com/) and [Browserstack](https://www.browserstack.com/) for supporting us. |
96 | | -This project uses code from several open source packages: |
97 | | -[Angular](https://angular.io), |
98 | | -[Clarity Design](https://clarity.design/), |
99 | | -[RxJS](https://github.com/ReactiveX/rxjs), |
100 | | -[Spring Flo](https://github.com/spring-projects/spring-flo), |
101 | | -[Ngx Toastr](https://github.com/scttcper/ngx-toastr), |
102 | | -[NGRX](https://ngrx.io/), |
103 | | -[luxon](https://moment.github.io/luxon//) (...) |
104 | | - |
105 | | -This project is powered by: |
106 | | - |
107 | | -<a href="https://www.vmware.com/"><img alt="VMWare" width="150" title="VMWare" src="https://i.imgur.com/xlFSgTU.png"></a> <a href="https://spring.io/"><img alt="Spring" title="Spring" src="https://i.imgur.com/az8Xady.png" width="155"></a> |
108 | | - |
109 | | -[Angular]: https://angular.io/ |
110 | | -[Angular CLI]: https://cli.angular.io/ |
111 | | -[frontend-maven-plugin]: https://github.com/eirslett/frontend-maven-plugin |
112 | | -[Git]: https://git-scm.com/ |
113 | | -[Maven]: https://maven.apache.org/ |
114 | | -[Node.js]: https://nodejs.org/ |
115 | | -[npm]: https://www.npmjs.com/ |
116 | | -[Protractor]: https://github.com/angular/protractor |
| 6 | +## This branch is locked - please file any issues in the [spring-cloud-dataflow-ui-commercial](https://github.com/spring-cloud/spring-cloud-dataflow-ui-commercial/tree/3.4.x) repo |
0 commit comments