@kaupang/studio 0.2.0 → 0.3.0

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 CHANGED
@@ -4,8 +4,9 @@
4
4
  [![license](https://img.shields.io/npm/l/@kaupang/studio.svg)](https://github.com/kaupang-dev/kaupang/blob/main/LICENSE)
5
5
 
6
6
  > A small web UI to browse a [kaupang](https://github.com/kaupang-dev/kaupang) catalog,
7
- > assemble environments + a solution, and **export a ready-to-run config**. No framework,
8
- > no CDN a single self-contained page.
7
+ > assemble environments + a solution, and **export a ready-to-run config**. Built with
8
+ > React + [React Flow](https://reactflow.dev) and bundled to a single self-contained
9
+ > page — no CDN, airgap-safe.
9
10
 
10
11
  ## Launch it
11
12
 
@@ -42,6 +43,18 @@ const { url, close } = await startStudio({ port: 8080, catalog: "./catalog.json"
42
43
  console.log(`studio on ${url}`);
43
44
  ```
44
45
 
46
+ ## Develop the UI
47
+
48
+ The web UI is a Vite + React + React Flow app under [`web/`](./web). It's built to a
49
+ single inlined `web/dist/index.html`, which the package's `tsup` build embeds as a string
50
+ and the server serves at `/`.
51
+
52
+ ```bash
53
+ kaupang studio --catalog ./catalog.json # terminal 1: the API on :8080
54
+ npm run dev -w @kaupang/studio # terminal 2: Vite dev server, proxies /api → :8080
55
+ npm run build -w @kaupang/studio # build:web (Vite single-file) + tsup bundle
56
+ ```
57
+
45
58
  ## License
46
59
 
47
60
  MIT © Andreas Quist Batista