NiiVue Monorepo

Monorepo for the NiiVue ecosystem — browser-based medical image visualization.

Packages

Apps

Getting Started

Use the hot-reloadable live demos for local development—they provide the fastest feedback loop while working on the project.

git clone [email protected]:niivue/mono.git
cd mono
bun install
bunx nx build niivue
git lfs install
git lfs pull
bun run dev

Core commands include

bun install                # Install all dependencies
bunx nx build <project>    # Build a single project (builds deps first)
bunx nx run-many -t build  # Build all projects
bunx nx run-many -t test   # Run all tests

See CONTRIBUTING.md for detailed setup, tooling, and development instructions.

Releasing and Publishing

Packages are versioned and published using Nx Release via the Release GitHub workflow:

• Release candidates are published automatically on every push to main. Each merged PR that contains releasable conventional commits produces new x.y.z-rc.N versions on the npm next dist-tag.
• Stable releases are manual. Run the Release workflow from the Actions tab on main with the "release candidate" box unchecked to publish x.y.z versions on the npm latest dist-tag.

See the Releases section of CONTRIBUTING.md for details. To publish by hand instead, ensure you are logged in to npm (npm login) and have publish access to the @niivue scope:

# 1. Version — bumps package.json and updates workspace deps
#    Use --first-release if no git tags exist yet for the project
bunx nx release version <version> --projects=<project>

# 2. Changelog (optional) — generate from conventional commits
bunx nx release changelog <version> --projects=<project>

# 3. Build
bunx nx run-many -t build --projects=<project1>,<project2>

# 4. Publish — run from each package directory
#    bun publish resolves workspace:* dependencies automatically
cd packages/<project> && bun publish --tag next --access public

Use --tag next for prerelease versions (e.g. 1.0.0-rc.1). Omit --tag for stable releases (defaults to latest). The --access public flag is required for scoped @niivue/* packages.

GitHub Pages

Pushing to main automatically builds and deploys all examples and demo apps to GitHub Pages. To preview the site locally:

.github/build-pages.sh --serve   # build and serve at http://localhost:8080/mono/