An application for analysing plant root systems, built with compatibility with the University of Nottingham's RootNav 2 API.
RootNavPortal is built on Electron, Node.js, React and Redux. put some pictures and banners in here for better styling later
Releases are on the GitHub releases page. Your application should auto-update when new releases are published.
First, clone the repo via git:
git clone https://github.com/Chagrilled/RootNavPortal
And then install the dependencies with yarn.
cd RootNavPortal
yarn
Starts the app in the dev
environment. This starts the renderer process in hot-module-replacement mode and starts a Webpack dev server that sends hot updates to the renderer process.
yarn dev
If you don't need autofocus when your files was changed, then run dev
with env START_MINIMIZED=true
:
$ START_MINIMIZED=true yarn dev
To run a production
build with full Webpack configuration, run
yarn build
yarn start
To package apps, use the specified package
script for your operating system:
yarn package-win
yarn package-mac
yarn package-linux
Note that RootNavPortal cannot be cross-compiled due to its native modules.
๐ก You can debug your production build with devtools by simply setting the DEBUG_PROD
env variable:
DEBUG_PROD=true yarn package
Plugins can be installed by placing a compatible JavaScript file into the application's /resources/plugins
folder. Refer to the wiki documentation when writing plugins.
In development, plugins will be copied from the plugins
folder into the installer's binary when packaging.