chartout 1.0.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/LICENSE +674 -0
- package/README.md +56 -0
- package/bundle/Widget.js +61759 -0
- package/bundle/lib.js +43 -0
- package/bundle/render.js +48618 -0
- package/bundle/types/index.d.ts +3 -0
- package/bundle/types/widget.d.ts +39 -0
- package/package.json +57 -0
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# chartout-app
|
|
2
|
+
|
|
3
|
+
Builds and publishes the **chartout** npm package — the interactive 3D widget used by the Python package and JavaScript reference implementation.
|
|
4
|
+
|
|
5
|
+
## Role in the ecosystem
|
|
6
|
+
|
|
7
|
+
| Repo | Role |
|
|
8
|
+
|------|------|
|
|
9
|
+
| **chartout** | Python package + JavaScript reference implementation |
|
|
10
|
+
| **chartout-api** | Backend API |
|
|
11
|
+
| **chartout-app** | This repo — widget bundle + npm package |
|
|
12
|
+
| **chartout-web** | Checkout web app |
|
|
13
|
+
|
|
14
|
+
## What gets built
|
|
15
|
+
|
|
16
|
+
| Output | Purpose |
|
|
17
|
+
|--------|---------|
|
|
18
|
+
| `bundle/Widget.js` | Self-contained Jupyter widget (loaded by the Python package) |
|
|
19
|
+
| `bundle/lib.js` | `createChartoutModel()` — state bridge for JS apps |
|
|
20
|
+
| `bundle/render.js` | `widgetRender` — anywidget render function for React apps |
|
|
21
|
+
| `bundle/types/` | TypeScript declarations |
|
|
22
|
+
|
|
23
|
+
## Development setup
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
git clone https://github.com/hoekinsights/chartout-app.git
|
|
27
|
+
cd chartout-app
|
|
28
|
+
pixi install
|
|
29
|
+
pixi run npm-install
|
|
30
|
+
pixi run npm-dev
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
`npm-dev` runs four watchers concurrently: `devwidget`, `devlib`, `devrender`, and `serve` (serves `bundle/` at `http://localhost:3000`).
|
|
34
|
+
|
|
35
|
+
To run the full ecosystem (API, Python, web app) alongside the widget:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
./scripts/start-dev.sh
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Build scripts
|
|
42
|
+
|
|
43
|
+
| Script | Output |
|
|
44
|
+
|--------|--------|
|
|
45
|
+
| `npm run build` | Full production build (widget + lib + render + types) |
|
|
46
|
+
| `npm run buildwidget` | `bundle/Widget.js` |
|
|
47
|
+
| `npm run buildlib` | `bundle/lib.js` |
|
|
48
|
+
| `npm run buildrender` | `bundle/render.js` |
|
|
49
|
+
| `npm run buildtypes` | `bundle/types/` |
|
|
50
|
+
| `npm run dev` | Watch all outputs + serve |
|
|
51
|
+
|
|
52
|
+
## Related repositories
|
|
53
|
+
|
|
54
|
+
- **chartout** — Python package and JavaScript reference implementation: https://github.com/hoekinsights/chartout
|
|
55
|
+
- **chartout-api** — Backend API: https://github.com/hoekinsights/chartout-api
|
|
56
|
+
- **chartout-web** — Checkout web app: https://github.com/hoekinsights/chartout-web
|