Book-a-Nook is an online platform where a user can look up for available community spaces like libraries and make reservation requests to the admin. The admin checks for the conflicts and sends the corresponding confirmations. Check full features and entities involved on the wiki home page.
The code is housed in a GitHub Repository.
- Rails 4.2.5
- RVM and Ruby >2.0.0 (tested on 2.2.1)
- PostgreSQL (Dev, Test)
Works well with:
- Ubuntu 14.04 + Ruby (2.2.2) + Rails 4.2.5
- MacOS X 10.9 + Ruby (2.2.2) + Rails 4.2.5
- Clone the repository
git clone https://github.com/berkmancenter/bookanook.git
Or clone down from your own fork of the repository.
Go to the application's root directory in terminal:
If you are using RVM, create gemset for this application:
rvm gemset create bookanook
Use the gemset:
rvm gemset use bookanook
Install gems from Gemfile:
* You may need to run
gem install bundle first.
* If you're having issues installing gems with
bundle install, try running
bundle update first.
- Make necessary changes (postgresql username and password) in config/database.yml
Here's a resource to help setup a username and password for PostgreSQL on your machine.
cp config/social_keys.yml.sample config/social_keys.yml. Add your own key and secret for Google authentication by setting up OAuth for your environment here.
Seed database with initial data:
Start the server:
Note: If you're having issues starting the server, try running
bundle exec rails server.
- Visit the application at localhost:3000
Tests are run using RSpec, by simply running
rspec in your terminal.
If you receive an issue about "Web Console is activated in the test environment" that is preventing your tests from running, remove the following gem from your Gemfile:
gem 'web-console', '~> 2.0'
Then in your terminal, run the following:
$ gem install bundler $ bundle install --without production
Please Log issues on GitHub.
The full list of contributors is available at https://github.com/berkmancenter/bookanook/graphs/contributors
- Create/Pick a relevant Issue: https://github.com/berkmancenter/bookanook/issues
- Code away!
- Send in a Pull Request.
NOTE: Will be posting a Contributing Guidelines Document soon.
Contact the following people if you get stuck:
Copyright © 2017 President and Fellows of Harvard College