|
1 |
| -**DataPipeUI** is a frontend build on *Angular* for [iris-datapipe](https://github.com/intersystems-ib/iris-datapipe), an **InterSystems IRIS** application which provides a set of re-usable components you can use to handle incoming data flow into ingestion, staging and operation phases in a homogeneus and flexible way. |
| 1 | +**DataPipeUI** is a user interface [iris-datapipe](https://github.com/intersystems-ib/iris-datapipe), an interoperability framework to ingest data in InterSystems IRIS in a flexible way. |
2 | 2 |
|
3 |
| -<img src="img/iris-datapipeUI.gif"> |
| 3 | +<img src="img/iris-datapipeUI-arch.png" width="600" /> |
4 | 4 |
|
5 |
| -Want to contribute to this project? See [CONTRIB.md](./CONTRIB.md) |
| 5 | +# QuickStart |
| 6 | +* Be sure you have [iris-datapipe](https://github.com/intersystems-ib/iris-datapipe) running. |
| 7 | +* After that, you can run the UI container: |
| 8 | +``` |
| 9 | +docker-compose up -d |
| 10 | +``` |
| 11 | +* Access the UI at http://localhost:8080/ and log-in using your InterSystems IRIS credentials. |
| 12 | + |
| 13 | +<img src="img/iris-datapipeUI.gif"> |
6 | 14 |
|
7 | 15 | # Configuration
|
8 | 16 | Set up environment files so you can reach you [iris-datapipe](https://github.com/intersystems-ib/iris-datapipe) instance.
|
9 | 17 | * [environment.ts](./src/environments/environment.ts) - non production environment
|
10 | 18 | * [environment.prod.ts](./src/environments/environment.ts) - production environment
|
11 | 19 |
|
12 |
| -# Build & Run |
13 |
| -*DataPipeUI* is an Angular application, so you can use usual Angular approachs to run it. You can do it locally or using a container. |
14 |
| - |
15 |
| -# Local |
16 |
| -If you have a local *Node.js* installation you build the application as follows: |
17 |
| - |
18 |
| -```console |
19 |
| -# install project dependencies |
20 |
| -npm install |
21 |
| -# non-production build |
22 |
| -ng build |
23 |
| -``` |
24 |
| - |
25 |
| -Then, to run the application: |
26 |
| -* Copy the generated `dist/DataPipeUI` package into you web server. |
27 |
| - |
28 |
| -# Container |
29 |
| -You can also run the application using a web server in a container. |
30 |
| - |
31 |
| -Check that [docker-compose.yml](./docker-compose.yml) is using a network so you can reach your iris-datapipe instance. |
32 |
| - |
33 |
| -Build & run the application: |
34 |
| -```console |
35 |
| -docker-compose up -d |
36 |
| -``` |
37 |
| - |
38 |
| -Application will be available at: |
39 |
| -* *Credentials*: use your *iris-datapipe* instance credentials |
40 |
| -* *URL*: http://localhost:8080/ |
| 20 | +Want to contribute to this project? See [CONTRIB.md](./CONTRIB.md) |
0 commit comments