Collaborative vectorial annotation tool for ultra high resolution data
JavaScript HTML Other
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 2 commits ahead, 80 commits behind r03ert0:master.
r03ert0 Merge pull request #4 from r03ert0/master
freshen up the neuroanatomy fork
Latest commit 113ac45 Dec 22, 2017
Permalink
Failed to load latest commit information.
.circleci instantiate config files in circleci Oct 19, 2017
bin first commit Mar 2, 2017
controller/data updated github strategy Oct 23, 2017
public fixing import statements Dec 18, 2017
routes fix linting issues Oct 13, 2017
test added reference images generated from docker Nov 9, 2017
views correcting links on the index.mustache for starts started on other ho… Nov 28, 2017
.eslintignore ignore .min.js files instead Oct 14, 2017
.eslintrc.js modify eslint rules Nov 9, 2017
.gitignore fix some lint errors in microdraw.js Oct 19, 2017
Dockerfile fixed puppeteer installation in dockerfile Nov 8, 2017
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md Oct 15, 2017
LICENSE.md fix merge Dec 1, 2015
PULL_REQUEST_TEMPLATE.md added the full set of functions and their expected behaviours to be c… Oct 15, 2017
README.md add CircleCI status Oct 18, 2017
app.js Merge pull request #113 from r03ert0/checkForMongoConnFail Dec 16, 2017
docker-compose.yml Added Dockerfile and docker-compose Oct 16, 2017
github-keys.json.example Update github-keys.json.example Oct 13, 2017
host.js logging in hostjs are now more meaningful, reflecting if the request … Nov 28, 2017
package-lock.json fixing import statements Dec 18, 2017
package.json fixed node-fetch dependency Oct 18, 2017
server_config.json.example working post method Oct 15, 2017
stop.js continuous integration on circleci Oct 17, 2017
test.js added a delay to test.js and a python script to compare test screenshots Nov 8, 2017

README.md

MicroDraw

CircleCI Join the chat at https://gitter.im/r03ert0/microdraw

microdraw-vervet

MicroDraw is a collaborative vectorial annotation tool for ultra high resolution data, such as that produced by high-throughput histology.

Data visualisation uses OpenSeadragon, and data annotation uses Paper.js.

Developer install instructions

as of 2017-08-15

Basic Steps

  • install nodejs

  • install mongo

  • checkout the repository git clone https://github.com/r03ert0/microdraw.git

  • cd microdraw

  • rename and adjust configuration example files

    • github-keys.json.example -> github-keys.json
      • Get your Github developer keys for your local microdraw url
    • public/js/base.js.example -> public/js/base.js (default should be var localhost = "http://localhost:3000";)
    • public/js/configuration.json.example -> public/js/configuration.json
    • server_config.json.example -> server_config.json
  • install the project

    • cd into microdraw
    • npm install
  • run the project

    • in one terminal window start mongod database and leave it run
    • in another terminal: cd into microdraw folder: npm start
  • open http://localhost:3000 to see MicroDraws landing page and click any of the data links provided

  • test data can be viewed at http://localhost:3000/data?source=/test_data/cat.json

To set up your own local data folder

  • cd to /public directory, put yourDataFolder here which must contain
    • a folder with the folders with your data tiles in dzi format
    • the .dzi file containing the information about your data (generated by the converter)
    • a json file containing information about your data in the following form: { "pixelsPerMeter": 1000000, "tileSources": [ "yourDataFolder/yourData.dzi" ] }

License

This project is licensed under GNU GPL v3 or any later version.