Web application for selecting primers.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
db
lib
public
spec
vendor/assets
.ctags
.gitignore
.hound.yml
.rspec
.sample.env
.travis.yml
Gemfile
Gemfile.lock
LICENSE.md
Procfile
README.md
Rakefile
browserslist
config.ru

README.md

PrimerFinder Build Status Coverage Status Code Climate

A simple web app for searching lists of primers to find the ones that bind the best to a target region.

An instance is freely available for use at https://primer-finder.herokuapp.com.

Setting up a development environment

PrimerFinder is written in Ruby using the Rails framework.

First, make sure you've got the version of Ruby specified in the Gemfile. As of this writing, that's 2.2.4. You'll almost certainly want to use a Ruby version manager to install and manage different versions of the language. I (@hrs) like to use chruby with ruby-install, but RVM and rbenv are also popular.

You can check your Ruby version with ruby -v.

We use bundler to manage library dependencies. Install the necessary libraries ("gems") specified in the Gemfile by running:

$ gem install bundler
$ bundle

After setting up, you can run the application using Heroku Local:

$ heroku local

Running tests

Once you've set up your dev environment, you should be able to run the tests! PrimerFinder has a small suite of unit and feature tests. Run them with:

$ rake

Deployment

The canonical instance of PrimerFinder is hosted on Heroku. It should be fairly easy to deploy your own copy there, if you'd like to:

  • Create a new Heroku instance.
  • Associate it with your local repository.
  • git push heroku master

Everything should just work.

Licensing

PrimerFinder's licensed under the GNU General Public License.

Guidelines

Use the following guides for getting things done, programming well, and programming in style.