base_project's Introduction

Default Project - Read Me

This is a default Ruby on Rails 4.0 project, using Ruby 2.0.0-p247. It is tested on OS-X Mountain Lion, with rbenv and uses bundler for gem management (via ~/.bundle/config).

Pre-requisites

OS-X Mountain Lion
rbenv and binstubs plugin
Ruby 2.0.0-p247
Rails 4.0.0
Postgresql
Growl

Default Gems

Database

Layout/View

haml-rails
bootstrap-sass

Development/Testing Tools

guard-rspec
guard-spork
guard-livereload
spork-rails
rb-fsevent
growl
pry-rails
better-errors
binding_of_caller
meta_request

Testing

rspec-rails
factory_girl_rails
faker
capybara
database_cleaner
launchy
selenium-webdriver
shoulda-matchers

Heroku (production)

rails_12factor

Default configuration covered by base_project

Bundler run with binstubs to be installed at .bundle/bin
run rails generate rspec:install
--format-documentation added to .rspec
config/application.rb updated with rspec and factory_girl generator settings
create Guardfile with settings for rspec, spork, growl and livereload
update spec/spec_helper.rb with spork, factory_girl, capybara and database_cleaner settings
replace application.html.erb with application.html.haml
remove/test directory (as this is unnecessary and causes conflicts with rspec, spork and guard)
includes bootstrap sass (application.js configured with bootstrap.js and bootstrap.css configured via custom.css.scss)
layout.html.haml updated to incorporate bootstrap (based on Bootstrap 3 Basic Template)

Setup

Clone the repository git clone [repo url] [new project name]
Remove git, run: rm -rf .git
Update reference to BaseProject and `base_project' to new project name via project wide find and replace
Create config/database.yml (see gist for format)
Run bundle install --binstubs .bundle/bin
Run rbenv rehash (to update the binstubs)
Run rake db:create:all
Replace this README.md

Recommend Projects