/minerva-story

Minerva Story is an image viewer that is designed specifically to make it easy for non-expert users to interact with complex tissue images.

Primary LanguageHTMLMIT LicenseMIT

Minerva

Check out the Minerva website for tutorials, example Minerva Stories and frequently asked questions about Minerva.

We also published a paper describing Minerva Story and Author: Hoffer et al., (2020). Minerva: a light-weight, narrative image browser for multiplexed tissue images. Journal of Open Source Software, 5(54), 2579, https://doi.org/10.21105/joss.02579 .

Minerva Repository Structure

Minerva Story

The GitHub Pages site build is stored at minerva-story. The source code for the minified bundle is stored at minerva-browser.

Minerva Author

The Python Flask server along with automated testing is stored at minerva-author. The React UI is stored at minerva-author-ui

Running Minerva Story

Clone repository

git clone git@github.com:labsyspharm/minerva-story.git
cd minerva-story

Install npm

Download and install Node.js for your platform.

Install npx to run the http-server:

npm install -g npx

Run local server

In the project folder, run command:

npx http-server -p 8000

Open browser to localhost:8000

Rebuilding minerva-browser

If you update the version of Minerva Browser in package.json, you will need to rebuild with webpack as shown below:

npm i
npm run build

Then you can run the local server with npx http-server -p 8000 as normal.