Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 2.14 KB

README.md

File metadata and controls

59 lines (42 loc) · 2.14 KB

Javascript phylogeny tree visualisation library

Phylogeny visualisation library for Newick tree format.

Forked from phylocanvas-3 development branch of Phylocanvas developed by The Centre for Genomic Pathogen Surveillance

phylogeny-tree example illustration

Packages

add package to your project using yarn add or npm install -S

development guide

Clone repository and run:

yarn install

Top-level commands

Start a development build, with optional testing page. page should match a folder in ./dev/pages.

yarn start [page]

Available pages with examples:

  • annotations
  • context-menu
  • interactions
  • metadata
  • scalebar
  • tooltip

Run yarn build inside each package, can be optionally scoped using the full package name, i.e. not the directory name.

yarn build [--scope=@mkoliba/phylogeny-tree-plugin-name]

Link every package globally.

yarn run link

Publishing a new version

  1. Run a new build (see above) and commit it.

  2. Login to npm

  3. Run yarn release.

[for beta releases, choose "Custom Version" and enter "3.0.0-beta.{number}"]