Skip to content

InsightSoftwareConsortium/itk-viewer

Repository files navigation

ITK-Viewer

Build and test

View and interact with multi-dimensional images, geometry, and point sets.

The ITK-Viewer a modern, elegant visualization library to that enables easier, faster, and more sustainable insights into your data.

ITK-Viewer makes it more enjoyable and seamless to add beautiful visualizations to your software.

Rendering and user interface components can be flexibly combined and customized when integrated into web browser, terminal, and traditional desktop applications. Standard Web Components follow the HTML First philosophy.

Development

Contributions are welcome and appreciated.

Build and test

npm i -g pnpm
pnpm i
pnpm build
pnpm test

Watch rebuild packages and run Vite dev server

npm i -g pnpm
pnpm i
pnpm dev

Then open http://localhost:5173/ in browser

Publish Steps

  1. In the branch that makes the modifications (or in another branch if you forgot) run pnpm changeset. Commit the changeset markdown file.
  2. Make a PR on main branch and merge. release.yml workflow sees there is a new changeset markdown file and creates a new chore: update versions PR.
  3. When ready to publish, merge the chore: update version PR on main and release.yml will publish new NPM packages.

Recipe that was followed to setup changesets in this repo:

https://pnpm.io/using-changesets#releasing-changes

About

Multi-dimensional web-based image, mesh, and point set viewer

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •