You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-22Lines changed: 3 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,6 @@ It contains the following packages, published to npm:
7
7
-[`@hyparam/components`](./packages/components): a library of React components and utilities for building Hyperparam UIs.
8
8
-[`hyperparam`](./packages/cli): a cli tool for viewing arbitrarily large datasets in the browser.
9
9
10
-
It also contains the following applications:
11
-
12
-
-[`hightable-demo`](./apps/hightable-demo): an example project showing how to use [hightable](https://github.com/hyparam/hightable).
13
-
-[`hyparquet-demo`](./apps/hyparquet-demo): an example project showing how to use [hyparquet](https://github.com/hyparam/hyparquet).
14
-
15
10
## Use
16
11
17
12
Install all the workspaces with:
@@ -44,20 +39,6 @@ Build all the workspaces (they are built in order, so the dependencies are built
44
39
npm run build -ws
45
40
```
46
41
47
-
Run an app:
48
-
49
-
-`hightable-demo`:
50
-
51
-
```bash
52
-
npm run dev -w hightable-demo
53
-
```
54
-
55
-
-`hyparquet-demo`:
56
-
57
-
```bash
58
-
npm run dev -w hyparquet-demo
59
-
```
60
-
61
42
-`hyperparam`:
62
43
63
44
```bash
@@ -74,10 +55,10 @@ npm run dev -w @hyparam/components
74
55
75
56
The monorepo is managed with [npm workspaces](https://docs.npmjs.com/cli/v10/using-npm/workspaces). Some workspaces are dependencies of others. Currently:
76
57
77
-
-`@hyparam/components` is a dependency of `hyperparam` and `hyparquet-demo`.
58
+
-`@hyparam/components` is a dependency of `hyperparam`.
78
59
79
-
It means that if you make a change to `@hyparam/components`, you need to rebuild it before developing `hyperparam` or `hyparquet-demo`.
60
+
It means that if you make a change to `@hyparam/components`, you need to rebuild it before developing `hyperparam`.
80
61
81
-
Also, if you increment the version of `@hyparam/components`, you need to update the version of `@hyparam/components` in the `package.json` of `hyperparam` and `hyparquet-demo`, as we use exact versions in the `package.json` of the workspaces. Note that we don't have to increment the version after every change, only when we want to publish a new version with a significant batch of changes.
62
+
Also, if you increment the version of `@hyparam/components`, you need to update the version of `@hyparam/components` in the `package.json` of `hyperparam`, as we use exact versions in the `package.json` of the workspaces. Note that we don't have to increment the version after every change, only when we want to publish a new version with a significant batch of changes.
82
63
83
64
The root package.json contains a special field, `overrides`, which sets the shared dependencies versions we want to have in all the workspaces. The "check_dependencies" GitHub action checks that the dependencies are the same in all the workspaces (`npm ls` would fail if dependency version mismatch).
0 commit comments