Skip to content

veg/alignment.js

Repository files navigation

alignment.js

A suite of reusable React components for creating a variety of visualizations involving multiple sequence alignments. View the live demo here.

alignment.js can be used to create standard MSA viewers, utilizing functional programming to permit custom behavior such as highlighting individual sites:

alt text

as well as scaffold viewers for next-generation sequencing data where a reference sequence stays fixed to the top:

alt text

and joint phylogeny/alignment viewers using packages like phylotree.js:

alt text

Installation

alignment.js is available on NPM and can thus be installed with npm

npm install alignment.js

or yarn

yarn add alignment.js

Development

Install a local copy:

git clone https://github.com/veg/alignment.js
cd alignment.js
yarn

Start the development server:

yarn start

Visit localhost:8000 in a browser (will read from environment variable $PORT).

Note that this starts webpack in watch mode; refresh to observe changes.

Deployment

Application

yarn build-app
yarn serve

Library

yarn build-lib