@databiosphere/findable-ui 0.0.0 → 0.0.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 +11 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# findable-ui
|
|
2
2
|
|
|
3
3
|
## General info
|
|
4
4
|
|
|
5
5
|
- `src` contains TypeScript source files; `lib` will contain compiled JavaScript, which is what should be imported by
|
|
6
6
|
the external application.
|
|
7
7
|
- Import paths used by the external application need to specify the full path starting from the package name,
|
|
8
|
-
in the form `@
|
|
8
|
+
in the form `@databiosphere/findable-ui/lib/<path>`, where `<path>` is the path of the file within the `lib`
|
|
9
9
|
folder.
|
|
10
10
|
|
|
11
|
-
## Developing
|
|
11
|
+
## Developing Findable UI alongside Data Biosphere Data Browser
|
|
12
12
|
|
|
13
13
|
1. Clone this repository into the same parent folder as
|
|
14
|
-
the [
|
|
15
|
-
2. Set `node` version to `
|
|
16
|
-
3. In the
|
|
14
|
+
the [Data Biosphere Data Browser](https://github.com/DataBiosphere/data-browser).
|
|
15
|
+
2. Set `node` version to `20.10.0` (this is also the version used by the Data Browser).
|
|
16
|
+
3. In the `findable-ui` repository directory:
|
|
17
17
|
- Run `npm ci`.
|
|
18
18
|
- [Bump the version number](https://docs.npmjs.com/cli/v6/commands/npm-version) in `package.json`
|
|
19
19
|
e.g. `npm version <update_type>`.
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
in VS Code so that it can be done with a keyboard shortcut).
|
|
24
24
|
4. In the Data Browser `explorer` directory (e.g. `data-browser/explorer`):
|
|
25
25
|
- Run `npm ci`.
|
|
26
|
-
- Update the `@
|
|
27
|
-
of
|
|
28
|
-
- Run `npm link ../../
|
|
29
|
-
to
|
|
26
|
+
- Update the `@databiosphere/findable-ui` dependency in the `package.json` file to use the new version
|
|
27
|
+
of Findable UI.
|
|
28
|
+
- Run `npm link ../../findable-ui`, which will create a symlink in node_modules pointing
|
|
29
|
+
to findable-ui.
|
|
30
30
|
- If any packages are later installed or uninstalled, the symlink will need to be created again, which can be done
|
|
31
|
-
with the same command or by running `npm link @
|
|
31
|
+
with the same command or by running `npm link @databiosphere/findable-ui`.
|