Electron Viewer

🚧 Example work in progress

This is an complete JavaScript example of VTK running on electron with vuejs (Nuxt).

Adventages of this solution:

• Platform agnostic
• Universal installer with Electron (Fixed chromiun version - no needs for independent uploads)
• VueJS (JavaScript)
• VuetifyJs for layout
• Good development experience with hot module replacement
• No OS dependencies, just nodejs.
• Integration test with Jest

Resources checked:

• vue-vtkjs-viewport live example
• vtk.js: https://kitware.github.io/vtk-js/examples/index.html
• Nuxt electron: https://github.com/michalzaq12/electron-nuxt

Development

# clone the repo

# install dependencies
yarn install

# serve app with hot reload
yarn dev

# build electron application for production
yarn build

# yarn tests
yarn test

# lint all JS/Vue component files in `src/`
yarn run lint

Licensing Notes

Tracking and understanding licensing Node applications can be tedious due to the 3rd party packages involved in the project.

You can run this command locally to check the number of licensing for the installed packages. npx license-checker --summary

See only production packages: npx license-checker --production

See all options here

Example:

 $ npx license-checker --production --summary
├─ MIT: 988
├─ ISC: 89
├─ CC0-1.0: 24
├─ BSD-2-Clause: 22
├─ BSD-3-Clause: 12
├─ Apache-2.0: 6
├─ (MIT OR CC0-1.0): 3
├─ Public Domain: 2
├─ BSD*: 2
├─ 0BSD: 2
├─ (MIT OR Apache-2.0): 1
├─ CC-BY-4.0: 1
├─ UNLICENSED: 1
├─ (WTFPL OR MIT): 1
├─ (MIT AND Zlib): 1
└─ (MIT AND BSD-3-Clause): 1