Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 3.51 KB

README.md

File metadata and controls

54 lines (35 loc) · 3.51 KB
Raw

LIMS3

This application aids emergency management and other agencies in managing both their personnel and their equipment.

Features:

  • Web-based user interface
  • Tracks complete data of personnel, including attendance, responsiveness and training
  • Tracks equipment, including serial numbers, sources, grants and service records
  • Will produce QR Codes of people to allow easier addition into a cell phone
  • will produce qr code to allow people to sign up for events
  • Will contact members via email, SMS over email and VOIP to alert them
  • Will capture availablity via VOIP IVR, SMS and email

Getting Started

This is a Rails project that is configured to run on Ruby 2, and on a Postgres database. So, the things you'll need to install before running LIMS locally are Ruby, the bundler gem, and Postgres version 9.

  1. Ruby: There's a detailed list of options for installing Ruby on the official Ruby website.
  • RVM, rbenv, and chruby are common ruby installation managers for Macs & Linux.
  • The exact version of Ruby that LIMS is using is specified in the .ruby-version file.
  1. Bundler: gem install bundler
  2. Postgres: If you have homebrew on a Mac, you can run brew install postgres.

Feel free to ask for help!

Contributing to LIMS: Coding 😃

One more thing to install: The testing framework requires the PhantomJS library. In order to code in LIMS, you'll need to install PhantomJS separately. With homebrew, you can run brew install phantomjs.

Then get the project code locally and set it up:

  1. git clone https://github.com/kgf/lims.git
  2. cd lims
  3. bundle install
  4. Copy config/database.example.yml to config/database.yml. Edit config/database.yml if necessary to match your postgres configuration.
  5. bundle exec rake db:create
  6. bundle exec rake db:schema:load

At this point you should be able to run the rails server via bundle exec rails s, the rails console via bundle exec rails c, and the tests via bundle exec rspec spec/

Note: You can use the UI to create a user and sign in, but the UI doesn't allow creation of an admin user. To use all the features of LIMS in the browser, you will need to enable admin privileges for your local user in the rails console after signing up via the UI.

Project Build Status:   Build Status

More information

See the wiki!

Contributing to LIMS: Community Expectations 🙌

We have a Code of Conduct to set clear expectations for community participation. We want participating in LIMS to be safe, fun, and respectful. We've adopted the "Contributor Covenant" model for our code of conduct, which is the same model that the Rails project itself uses. (Other projects that use a Code of Conduct of this type include RSpec, Jenkins, and RubyGems.)

Please read the Code of Conduct. By participating in this project you agree to abide by its terms.