pdxCoders: A Ruby repository from galxy25

#pdxCoders/UEBPrep ##Build Status [] ##CodeClimate Grades [] []

##Developer Environment Setup Prerequisites

Vagrant Software
VirtualBox Software
GitHub account && access to project repo
Copy of uebprep.box
Copy of application.yml (environment variables and secret keys)

Steps(nix computers)

Clone the repository 
$> git clone https://github.com/galxy25/pdxCoders.git
Move to the application code  directory 
$> cd pdxCoders/UEBPREP
Copy over the application.yml file
$> mv /path/to/appliction.yml ./config
Create a virtual machine environment 
$> vagrant box add ueb /path/to/uebprep.box --force
Initialize your virtual machine 
$> vagrant up
Ssh to the running machine
$> vagrant ssh
$> cd /vagrant
Install gems for the project
$> bundle install
Set up your database
$> bundle exec rake db:drop db:create db:migrate
Add initial data for db
$> bundle exec rake db:seed

For window developers, much of the steps are the same, see: Windows Vagrant Setup

##Running the application

Start both the app and delayed job threads 
$> bundle exec foreman s -f Procfile-dev

##Testing Run one of two commands to run the complete test suite for the app

$> bundle exec rspec
--or---
$> bundle exec rake test

##Source Control Process: Feature Branch Workflow

Production branch ---> master
Branch for development work ---> development
Branch for testing environment server ---> staging-beta
Branch prefixes: chores|features|bugs|spikes|releases|hotfixes

Typical developer flow:

$> git checkout development
$> git pull
$> git checkout -b features/story_name_1234

Where 1234 == Story ID in Pivotal Tracker

After you finish work on your branch, create a pull request, leave commits, and after at least one other person has signed off with a 'LGTM'(Looks Good To Me) you may merge it into staging beta, which will then push the changes to development if all the tests pass.

Feature Branch Workflow In Depth Explanation

Merges to production/master will be handled by the team lead.

#Deploying new code CAT has uploaded our public keys onto the hosting server, to trigger the build scripts for both the staging and production environments, run $> ssh -i path/to/private_key uebprep@brailleuno.ece.pdx.edu

#License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 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.