katytaylor / labwhere

A tool for tracking uniquely barcoded labware

Labwhere

A tool for tracking uniquely barcoded labware

Getting Started

1. Get the right Ruby version Make sure you have ruby-2.5.6 installed. e.g. rvm install ruby-2.5.6.

2. Create a new gemset and install bundler (if necessary)

   rvm use ruby-2.5.6@rails526 --create
   gem install bundler

3. Install the dependencies: bundle install

4. Set up the local database The local database uses sqlite.

   bundle exec rails db:environment:set
   bundle exec rails db:create
   bundle exec rails db:migrate

Running The Specs

bundle exec rspec

Running The Server

bundle exec rails server

Generating the API Documentation

bundle exec rails docs:api

The documentation is written in API Blueprint and converted to HTML using the Apiary CLI client gem.

The documentation will be available at /api.