Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update package name in readme (#4) #38

Merged
merged 1 commit into from
Apr 16, 2024
Merged

docs: update package name in readme (#4) #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# data-explorer-ui
# findable-ui

## General info

- `src` contains TypeScript source files; `lib` will contain compiled JavaScript, which is what should be imported by
the external application.
- Import paths used by the external application need to specify the full path starting from the package name,
in the form `@clevercanary/data-explorer-ui/lib/<path>`, where `<path>` is the path of the file within the `lib`
in the form `@databiosphere/findable-ui/lib/<path>`, where `<path>` is the path of the file within the `lib`
folder.

## Developing the Clever Canary Data Explorer alongside Clever Canary Data Browser
## Developing Findable UI alongside Data Biosphere Data Browser

1. Clone this repository into the same parent folder as
the [Clever Canary Data Browser](https://github.com/clevercanary/data-browser).
2. Set `node` version to `16.15.0` (this is also the version used by the Data Browser).
3. In the Data Explorer `packages/data-explorer-ui` directory (e.g. `data-explorer/packages/data-explorer-ui`):
the [Data Biosphere Data Browser](https://github.com/DataBiosphere/data-browser).
2. Set `node` version to `20.10.0` (this is also the version used by the Data Browser).
3. In the `findable-ui` repository directory:
- Run `npm ci`.
- [Bump the version number](https://docs.npmjs.com/cli/v6/commands/npm-version) in `package.json`
e.g. `npm version <update_type>`.
Expand All @@ -23,9 +23,9 @@
in VS Code so that it can be done with a keyboard shortcut).
4. In the Data Browser `explorer` directory (e.g. `data-browser/explorer`):
- Run `npm ci`.
- Update the `@clevercanary/data-explorer-ui` dependency in the `package.json` file to use the new version
of `data-explorer-ui`.
- Run `npm link ../../data-explorer/packages/data-explorer-ui`, which will create a symlink in node_modules pointing
to data-explorer-ui.
- Update the `@databiosphere/findable-ui` dependency in the `package.json` file to use the new version
of Findable UI.
- Run `npm link ../../findable-ui`, which will create a symlink in node_modules pointing
to findable-ui.
- If any packages are later installed or uninstalled, the symlink will need to be created again, which can be done
with the same command or by running `npm link @clevercanary/data-explorer-ui`.
with the same command or by running `npm link @databiosphere/findable-ui`.
Loading