Skip to content
Manage equipment loans & reservations. Who can borrow what, for how long?
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config Rotate log files after 150 MB (retain 5) Aug 8, 2018
db Add migration to fix incorrect overdue_count Jun 25, 2018
doc move reservations db diagram to doc dir [ci skip] Jan 21, 2015
lib
public moved favicon for Rails 4 Sep 30, 2014
script Cleaned up the mess I made, by deleting all these unncesesary files Jun 1, 2012
spec Fixing user CSV importer bug Dec 5, 2018
vendor/assets Improve user profile reservation tables Jan 19, 2016
.codeclimate.yml
.env.example
.eslintrc.yml Add ESlint to Travis; only style check the diff Aug 8, 2016
.gitignore
.jscsrc
.jshintignore add jscs and jshint Dec 31, 2014
.jshintrc add jscs and jshint Dec 31, 2014
.rspec removed Spork from .rspec Jul 25, 2014
.rubocop.yml
.ruby-version Update to Rails 5.1.2 Aug 8, 2017
.travis.yml
CHANGELOG.md
CONTRIBUTING.md Add CONTRIBUTING.md Mar 30, 2015
Capfile
Gemfile Update rails_admin from 1.2.0 -> 1.3.0 Jul 12, 2018
Gemfile.lock
Guardfile
LICENSE Update LICENSE Mar 30, 2015
Procfile
README.md
Rakefile
app.json Fix issues with Paperclip and S3 Dec 6, 2017
config.ru
package.json
test

README.md

Welcome to Reservations

Build Status Code Climate Test Coverage Dependency Status Inline docs

Deploy

Reservations makes it easy to manage the checking in and out of equipment, much like a library! Here are some of the things Reservations can do:

  • manage your inventory of equipment, including storing serial numbers, manuals and other documents, and more.
  • present an attractive catalog of equipment, including pictures, so people can browse and search your equipment.
  • allow people to reserve equipment in advance, according to rules you set.
  • enforce rules on who can reserve what equipment, and for how long.
  • manage checking in/out equipment, including unique checklists for each item.

Getting Started

There are two mains steps to setting up Reservations: setting up a deployment server, and installing the Reservations application.

Prerequisites

You'll need the following to run Reservations:

Installation

For troubleshooting, see our wiki.

First, checkout a copy of Reservations using git:

cd /your/code/directory
git clone https://github.com/YaleSTC/reservations.git
cd reservations

Reservations uses Bundler to manage dependencies, so if you don't have it, get it, then install dependencies:

gem install bundler
bundle install

You'll need to edit config/database.yml to point to your database, including the correct username and password. See Rails Guides for common database examples. We package a few example files in the config/ folder for Ubuntu, Fedora, and OS X.

Then, create the database and load the database structure:

rake db:create
rake db:schema:load

Finally, start the app locally:

rails server

Just point your browser to localhost:3000 to use Reservations.

Deploying to a Server

Reservations is built using Ruby on Rails, and can be set up (deployed) like most Rails apps. You'll need a server running with the following software:

  • Ruby 2.1
  • database server (MySQL is preferred, but any database supported by Rails should work, including PostgreSQL)
  • web server (apache or nginx both work well)
  • Rails application server (usually Passenger Phusion aka mod_rails)

For a general guide to setting up your web and application servers, including hosting providers, see the Rails Deployment Guide. For a guide to using our Capistrano deployment script, see the wiki. For a guide to deploying Reservations to Heroku, see the wiki as well.

Configuration

Reservations uses environment variables for configuration (following the principles of the Twelve-Factor App). The gems dotenv and dotenv-deployment can be used to simulate system environment variables at runtime.

In the development and test Rails environments, most of the configuration is set in the config/secrets.yml file. IMPORTANT You should copy the config/secrets.yml file and regenerate all of the secret keys / tokens using rake secret. You should also copy over the config/database.yml.example.* file relevant to your platform and follow the instructions linked to above to set up your database.

In production, the config/database.yml.example.production should be used as it will refer to the relevant environment variables. Additionally, you must define most of the configuration environment variables listed here in order for Reservations to work.

Authentication

By default, Reservations uses e-mail addresses and passwords to authenticate users with the devise gem. It also supports the CAS authentication system, using the gem devise_cas_authenticatable. If you want to use CAS authentication you must set the CAS_AUTH and CAS_BASE_URL environment variables to the appropriate values (see here for more details). Switching between authentication methods after initial setup is possible with some caveats (see our wiki for more details).

To point the gem to the correct CAS server in the development and test Rails environments, modify the following setting in your app's config/secrets.yml file (see above):

  cas_base_url: https://secure.its.yale.edu/cas/

Change the cas_base_url parameter to your CAS server's base URL; also note that many CAS servers are configured with a base URL that looks more like “cas.example.com/cas”.

Time Zone

Reservations ships with the default config time set to Eastern Time (US and Canada). To change the time, edit config/application.rb config.time_zone = 'Eastern Time (US & Canada)'.

Further Documentation

  • Administrators and end-users may like to review our help documentation.
  • IT System Administrators and developers interested in deploying or getting involved with Reservations can find information on our project wiki

Suggestions and Issues

If you have any suggestions, or would like to report an issue, please either:

You can’t perform that action at this time.