arbor-dashboard 1.65.0 → 1.66.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 +27 -27
- package/dist/main.js +8 -8
- package/package.json +18 -2
package/README.md
CHANGED
|
@@ -8,56 +8,56 @@ An npm package of responsive charting components for data visualisation
|
|
|
8
8
|
|
|
9
9
|
- Node.js
|
|
10
10
|
- Yarn package manager
|
|
11
|
+
- [Tilt](https://tilt.dev) (for the recommended local setup)
|
|
11
12
|
|
|
12
|
-
###
|
|
13
|
+
### Running locally
|
|
13
14
|
|
|
14
|
-
|
|
15
|
+
#### Option 1 - Tilt (recommended)
|
|
15
16
|
|
|
16
|
-
|
|
17
|
-
yarn
|
|
18
|
-
```
|
|
17
|
+
Tilt handles all dependency installation and starts the backend (port 3000) and frontend automatically. Pass a port for the Tilt UI:
|
|
19
18
|
|
|
20
|
-
2. Install backend dependencies:
|
|
21
19
|
```bash
|
|
22
|
-
|
|
23
|
-
yarn
|
|
20
|
+
tilt up --port 10351
|
|
24
21
|
```
|
|
25
22
|
|
|
26
|
-
|
|
23
|
+
Open [http://localhost:5173](http://localhost:5173).
|
|
24
|
+
|
|
25
|
+
#### Option 2 - Manual
|
|
26
|
+
|
|
27
|
+
Install dependencies first:
|
|
28
|
+
|
|
27
29
|
```bash
|
|
28
|
-
cd local/Frontend
|
|
29
30
|
yarn
|
|
31
|
+
cd local/backend && yarn
|
|
32
|
+
cd local/Frontend && yarn
|
|
30
33
|
```
|
|
31
34
|
|
|
32
|
-
|
|
35
|
+
Then start the backend and frontend in separate terminals:
|
|
33
36
|
|
|
34
|
-
1. Navigate to the backend directory:
|
|
35
37
|
```bash
|
|
36
|
-
|
|
37
|
-
|
|
38
|
+
# Terminal 1 - backend (port 3000)
|
|
39
|
+
cd local/backend && node app.js
|
|
38
40
|
|
|
39
|
-
2
|
|
40
|
-
|
|
41
|
-
node app.js
|
|
41
|
+
# Terminal 2 - frontend (port 5173)
|
|
42
|
+
cd local/Frontend && npm run dev
|
|
42
43
|
```
|
|
43
44
|
|
|
44
|
-
|
|
45
|
-
|
|
45
|
+
## Storybook
|
|
46
|
+
|
|
47
|
+
The component library is documented and previewed in Storybook.
|
|
48
|
+
|
|
49
|
+
To start the development server on port 6006:
|
|
46
50
|
|
|
47
|
-
### Running the Frontend
|
|
48
|
-
1. Navigate to the frontend directory:
|
|
49
51
|
```bash
|
|
50
|
-
|
|
52
|
+
yarn storybook
|
|
51
53
|
```
|
|
52
54
|
|
|
53
|
-
|
|
55
|
+
To run the story tests:
|
|
56
|
+
|
|
54
57
|
```bash
|
|
55
|
-
|
|
58
|
+
yarn test:storybook
|
|
56
59
|
```
|
|
57
60
|
|
|
58
|
-
3. The frontend will be available at:
|
|
59
|
-
http://localhost:5173/
|
|
60
|
-
|
|
61
61
|
|
|
62
62
|
## Developing with SIS
|
|
63
63
|
> Note: this is only recommended for end to end developing - for general developing of charts in this library use the packaged dev server, [usage guide here](https://arbor-education.slite.com/app/docs/SgIhOMBxZQLGOc#5xRs7JNsgNP0HB)
|