arbor-dashboard 2.0.0-react19-alpha.0 → 2.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/README.md +10 -0
- package/dist/main.js +8 -8
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
An npm package of responsive charting components for data visualisation
|
|
4
4
|
|
|
5
|
+
> Consumers must also install `@arbor-education/design-system.components` (a peer dependency used by the `table` chart type) and load its CSS. See **Getting Started → Using the Components** in Storybook.
|
|
6
|
+
|
|
5
7
|
## Getting Started
|
|
6
8
|
|
|
7
9
|
### Prerequisites
|
|
@@ -42,6 +44,14 @@ cd local/backend && node app.js
|
|
|
42
44
|
cd local/Frontend && npm run dev
|
|
43
45
|
```
|
|
44
46
|
|
|
47
|
+
[http://localhost:5173](http://localhost:5173) loads the mock dashboard in `local/Frontend/layout.json`, served by the local backend. On the horizontal **Suspensions and behaviour incidents by year group** chart, click a bar to open a drill-down of suspensions by school. That example uses the local mock API, so it does not need a Stats API token. The same interaction is in Storybook as **Components/Dashboard/Dashboard → Drill-down**.
|
|
48
|
+
|
|
49
|
+
### Attendance drill-down
|
|
50
|
+
|
|
51
|
+
Chart drill-down is exercised on a separate page that loads `local/Frontend/attendanceLayout.json` and calls the Stats API. With the frontend running (Tilt or `npm run dev`), open [http://localhost:5173/drilldown.html](http://localhost:5173/drilldown.html).
|
|
52
|
+
|
|
53
|
+
Paste a Stats API token on the page, or set `VITE_STATS_JWT` in `local/Frontend/.env` so it connects on load. Requests go through the Vite proxy to the QA Stats API (`https://data-stats-api.qa.arbor.engineering`). Override that target with `STATS_API_URL` when starting the dev server.
|
|
54
|
+
|
|
45
55
|
## Storybook
|
|
46
56
|
|
|
47
57
|
The component library is documented and previewed in Storybook.
|