onepipeline-ui 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,22 @@
1
+ # onepipeline-ui
2
+
3
+ The DAG Observatory: the browser view of [onepipeline](https://crates.io/crates/onepipeline)
4
+ runs. This package carries the **built frontend** — a static bundle under `dist/` —
5
+ and no binary. The read API it talks to ships separately as
6
+ [`onepipeline-api-cli`](https://www.npmjs.com/package/onepipeline-api-cli).
7
+
8
+ ```sh
9
+ npm install onepipeline-ui
10
+ ```
11
+
12
+ Serve `node_modules/onepipeline-ui/dist` from any static file server, and put the read
13
+ API behind the same origin at `/api` and `/healthz`:
14
+
15
+ ```sh
16
+ npx onepipeline-api-cli serve --runs-root ./runs # the API, on 127.0.0.1:8765
17
+ npx serve node_modules/onepipeline-ui/dist # the view
18
+ ```
19
+
20
+ The app declares no schema, event name, or API path of its own: every payload it reads
21
+ is validated against the contract in
22
+ [`docs/contract.md`](https://github.com/nickderobertis/onepipeline-ui/blob/main/docs/contract.md).