Manage equipment loans & reservations. Who can borrow what, for how long?
This project has moved to https://gitlab.com/yale-sdmp/reservations. Please visit that repo for the latest releases and to report issues. This repository will no longer be monitored.
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:
There are two mains steps to setting up Reservations: setting up a deployment server, and installing the Reservations application.
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:
Just point your browser to
localhost:3000to use Reservations.
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:
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.
Reservations uses environment variables for configuration (following the principles of the Twelve-Factor App). The gems
dotenv-deploymentcan be used to simulate system environment variables at runtime.
testRails environments, most of the configuration is set in the
config/secrets.ymlfile. IMPORTANT You should copy the
config/secrets.ymlfile 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.
config/database.yml.example.productionshould 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.
To develop this app locally with Docker, 1. Copy
.env.examplefor a full list of available environment variables. 2. Copy
config/database.yml. 3. Run
docker-compose up -d. 4. On initial setup, run
docker-compose run web bin/setup.
To develop locally without Docker: 1. Copy
.env. 2. Copy
config/database.yml. 3. Run rake db:create and rake db:schema:load
devise_cas_authenticatable. If you want to use CAS authentication you must set the
CAS_BASE_URLenvironment 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.ymlfile (see above):
yaml cas_base_url: https://secure.its.yale.edu/cas/Change the
cas_base_urlparameter 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”.
Reservations ships with the default config time set to Eastern Time (US and Canada). To change the time, edit
config.time_zone = 'Eastern Time (US & Canada)'.