BAMRU Flex

This is the code for the BAMRU Flex website.

Maintaing and Contributing

Target Audience

To be a successful maintainer/contributor, you'll need reasonable familiarity with linux, git, ruby & rails.

Bootstrap & Run in Development Mode

This app has been developed on Ubuntu 12.04. It will probably work on a Mac. It won't run on a vanilla PC, but may work with Cygwin.

To bootstrap the app:

• clone the repo
• install ruby 1.9.3
• install sqlite3
• run bundle install
• run rake db:migrate
• run rake db:data:load

FYI The calendar data for this prototype is at http://bamru.org/calendar.csv.

To run the app in development:

• run rails server

Provisioning a Server

We use a combination of shell scripts and Puppet manifests to auto-configure the staging and production servers.

See the Vagrantfile and the "bootstrap-base" shell script to learn how auto-provisioning is done.

Deploying the App

This app is built to use four deployment environments:

• vagrant - for development (requires vagrant/virtualbox)
• devstage - local staging server for integration testing
• pubstage - public staging server for integration testing
• production - the live system

Deploying to Vagrant: Provision the Box

• create and provision the VM using vagrant up
• setup ssh using vagrant ssh-config >> ~/.ssh/config
• add 'dns lookup' using sudo echo '192.168.33.12 vagrant' >> /etc/hosts

Deploying to Vagrant: Bootstrap & Run the App

• edit your Capfile to set the default stage to 'vagrant'
• initialze the app using cap deploy:setup ; cap deploy:cold
• upload the images & load database using cap data:init
• deploy the working system using cap deploy
• run a tmux-dashboard using cap console

Deploying to Staging and Production: ask Andy for instructions

Git Organization

The Git repo is organized to roughly follow the nvie guidelines. The main branches in the repo include:

• master - used for production deploy
• dev - default branch for vagrant & staging deploys
• dev-feature - feature branch

Contributing to the App

Contributions are encouraged!

• fork the repo
• clone & edit your fork
• make your edits in a separate development branch
• include tests!
• send pull-requests to Andy

License

Copyright (c) 2011-2012 Andy Leak

Permitted Use

Permission is hereby granted, free of charge, to any BAMRU member obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software for non-commercial purposes associated with BAMRU adminstration and operations. Within this context, the rights to use, copy, modify, merge, publish, and distribute are provided, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Non-Permitted Use

Non-Permitted Use is any use of the Software for purposes other than BAMRU administration and operations. For Non-Permitted Use, rights to copy, modify, distribute, or reuse the Software are denied. For all Uses, rights to sublicense and/or sell copies of the Software, to permit persons to whom the Software is furnished to do so, or to create derivitave works, whether commercial or non-commercial, are denied.