Intuitive local web frontend for the BLAST bioinformatics tool
JavaScript Ruby HTML CSS
Permalink
Failed to load latest commit information.
.bootstrap Upgrade to Bootstrap 3.3.5. Aug 16, 2015
LICENSE
bin Add explicit download path message Sep 20, 2015
docker Move Dockerfile to folder to avoid loading local context Mar 3, 2016
lib Refactoring around table of hits and report generation. Aug 25, 2016
public
spec golden output should be 19 instead of 18 Mar 23, 2016
views
.codeclimate.yml Revise front-end and build architecture. Aug 29, 2015
.gitignore
.mailmap
.rspec Rubocop! Feb 2, 2015
.rubocop.yml Open results in new page. Aug 7, 2015
.travis.yml Re-enable testing master on Travis. Mar 21, 2016
COPYRIGHT.txt Switch to GNU AGPL version 3. Feb 23, 2015
Gemfile
LICENSE.txt Switch to GNU AGPL version 3. Feb 23, 2015
README.md
Rakefile Revise front-end and build architecture. Aug 29, 2015
config.ru Add Capybara headless testing framework Dec 22, 2014
package.json Build and load CSS from css/. Build assets once. Aug 26, 2016
sequenceserver.gemspec

README.md

build status code climate coverage gem version total downloads

gitter chat

SequenceServer - BLAST searching made easy!

SequenceServer lets you rapidly set up a BLAST+ server with an intuitive user interface for use locally or over the web.

Please cite: Priyam A, Woodcroft BJ, Rai V, Munagala A, Moghul I, Ter F, Gibbins MA, Moon H, Leonard G, Rumpf W & Wurm Y. 2015. Sequenceserver: A modern graphical user interface for custom BLAST databases. biorxiv doi: 10.1101/033142.

Install and configure

Please see http://sequenceserver.com.

Develop and contribute

You will need Ruby and RubyGems, Node and npm, and CodeClimate. Further, please note that 1.0.x branch contains the stable releases, while the master branch is a work in progress towards next release and may be buggy.

Setup

Get source code and install dependencies.

git clone https://github.com/wurmlab/sequenceserver
gem install bundler
cd sequenceserver
npm install
bundle

We use Capybara with WebKit driver for functional testing, which requires qt to be installed. If bundle fails, install qt (On Mac: brew install qt) and run bundle again.

We use JSPM (via Node) for front-end package management and building JavaScript and CSS files.

If you are deploying SequenceServer from git you can skip npm install step and skip installing gems used for testing (and qt), etc. by running:

bundle install --without=development

Run, test, build

Launch SequenceServer in development mode. In development mode SequenceServer logs verbosely and uses raw front-end files.

bundle exec bin/sequenceserver -D

Run the specs, lint the code, build front-end and package everything as a gem.

rake

Sometimes you may just want to run the specs or lint the code:

rake spec
rake lint

Using Docker

# With database fasta files inside a folder named db
docker run --rm -ti -p 4567:4567 -v $(pwd)/db:/db wurmlab/sequenceserver

Contact