Skip to content

Latest commit

 

History

History

README.md

b r e a d c r u m b s

simple and scalable graph annotation

Installation

$ yarn

Running a development server

$ yarn start

This will run a development server in your shell (with linting and transpile outputs), and will automatically open your browser to http://localhost:3000 where it will display the running breadcrumbs app. Saving files to the breadcrumbs filesystem will trigger a rebuild and will restart the server (refreshing your page).

Usage

Mouse

Command Description
LMB Click to place a new node (Trace Mode only)
RMB Drag to pan around the scene. Click to select a node
MMB Scroll to scrub through the z-stack

Keyboard

Command Description
q, e Pan up and down in the z-stack
+, - Zoom in and out
a Mark the current node as an Axon
d Mark the current node as a Dendrite
! Mark the current node as a bookmark, to return to later. (Press again to toggle)
@ Return to the previous bookmark
delete Delete the currently active node
esc Reset the zoom and pan of the scene
T Toggle trace visibility

Contributors


Jordan Matelsky

💻 💬

Tucker Chapin

💻

Joe Downs

💻

[emoji key]

Deploying

  • Build the application.
yarn build
  • Zip the build.
zip -r build.zip build/*
  • Upload the build.

You'll need access to the AWS console in order to do this: Get in touch with a project maintainer.