README.md

niivue-desktop

This is the desktop app that builds on the core NiiVue WebGL 2.0 medical image viewer.

Development and Building

1. git clone --recurse-submodules https://github.com/niivue/niivue-desktop.git
2. cd niivue-desktop
3. npm install

Run app in Dev mode

note that the electron code does not offer hot reload. Hot reload only applies to the UI if you make changes to those files while the app is running.

npm run dev

Run app without hot reload before packaging

npm run start

Package app

does not bundle for distribution

npm run package

Package and bundle

creates a zip to share

npm run make