arbor-dashboard 1.44.0 → 1.45.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 +62 -2
- package/dist/dashboard.js +74 -1
- package/dist/dashboard.js.LICENSE.txt +19 -0
- package/dist/main.js +74 -1
- package/dist/main.js.LICENSE.txt +19 -0
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -45,7 +45,6 @@ node app.js
|
|
|
45
45
|
http://localhost:3000/
|
|
46
46
|
|
|
47
47
|
### Running the Frontend
|
|
48
|
-
|
|
49
48
|
1. Navigate to the frontend directory:
|
|
50
49
|
```bash
|
|
51
50
|
cd local/Frontend
|
|
@@ -57,4 +56,65 @@ npm run dev
|
|
|
57
56
|
```
|
|
58
57
|
|
|
59
58
|
3. The frontend will be available at:
|
|
60
|
-
http://localhost:5173/
|
|
59
|
+
http://localhost:5173/
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
## Developing with SIS
|
|
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)
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
To watch for changes in your local version of this project as a dependency in SIS (or another project) instead of the published npm version, do the following. Note it is extremely flaky and to be perfectly honest I've found if any of these steps goes wrong or happens in the wrong order you're best just to restart your laptop (or ideally buy a new one) and start it all again.
|
|
67
|
+
### Prerequisites
|
|
68
|
+
You'll have to have fe-library running in develop mode (or whichever project is consuming this watching for changes. If you're using this in a different project, adapt the commands for fe-library to whichever package manager & transpiler you are using).
|
|
69
|
+
|
|
70
|
+
### 1. Clean up node modules (keeping lock files)
|
|
71
|
+
In both this project root and fe-library/client, run:
|
|
72
|
+
```bash
|
|
73
|
+
rm -rf node_modules
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### 2. Install dependencies
|
|
77
|
+
In each repo, run:
|
|
78
|
+
```bash
|
|
79
|
+
yarn install
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### 4. Symlink the arbor-dashboard package
|
|
83
|
+
In this project root, run:
|
|
84
|
+
```bash
|
|
85
|
+
yarn link
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
In fe-library/client, run:
|
|
89
|
+
```bash
|
|
90
|
+
yarn link arbor-dashboard
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### 5. Symlink react from fe-library
|
|
94
|
+
This is to resolve conflicts in different versions. In fe-library/client, run:
|
|
95
|
+
```bash
|
|
96
|
+
cd node_modules/react && yarn link && cd ../react-dom && yarn link && cd ..
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Then in arbor-dashboard, run:
|
|
100
|
+
```bash
|
|
101
|
+
yarn link react && yarn link react-dom
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### 6. Build fe-library in watch mode
|
|
105
|
+
In fe-library/client run:
|
|
106
|
+
```bash
|
|
107
|
+
yarn run grunt
|
|
108
|
+
```
|
|
109
|
+
### 7. Build arbor-dashboard (this package) in watch mode
|
|
110
|
+
In this project root, run:
|
|
111
|
+
```bash
|
|
112
|
+
yarn webpack --watch
|
|
113
|
+
```
|
|
114
|
+
### 8. Reinstall or re-link after any yarn install
|
|
115
|
+
If you run yarn install in either repo, you may need to repeat the yarn link steps to restore symlinks.
|
|
116
|
+
|
|
117
|
+
### 9. Troubleshooting
|
|
118
|
+
- If you see missing files (e.g., RefreshUtils.js), delete node_modules and reinstall.
|
|
119
|
+
- If you see the React hooks/dispatcher error, check for duplicate Reacts.
|
|
120
|
+
- Only one version should appear, and only in the client’s node_modules.
|