Permalink
Browse files

[#19] Clean up

* Remove unused doc directory.
* Remove unnecessary .gitkeep file.
* Remove unused `will_paginate` gem.
* Use standard `bundle exec rake` instead of `bake` alias.
  • Loading branch information...
1 parent eb3b9a0 commit 7b28bfb25bc18bc8af236581f162a4909f2d4762 @croaky croaky committed Mar 15, 2012
Showing with 2 additions and 3,933 deletions.
  1. +0 −1 Gemfile
  2. +0 −2 Gemfile.lock
  3. +2 −4 README.md
  4. +0 −166 doc/README_FOR_SUSPENDERS
  5. +0 −3,760 doc/diagrams.graffle
  6. 0 tmp/.gitkeep
View
1 Gemfile
@@ -8,7 +8,6 @@ gem 'jquery-rails', '1.0.19'
gem 'pg', '0.13.2'
gem 'rails', '3.1.1'
gem 'thin', '1.3.1'
-gem 'will_paginate', '3.0.3'
gem 'yajl-ruby', '1.1.0', :require => 'yajl'
group :development do
View
2 Gemfile.lock
@@ -168,7 +168,6 @@ GEM
polyglot
polyglot (>= 0.3.1)
tzinfo (0.3.32)
- will_paginate (3.0.3)
xpath (0.1.4)
nokogiri (~> 1.3)
yajl-ruby (1.1.0)
@@ -198,5 +197,4 @@ DEPENDENCIES
spork (= 0.9.0)
thin (= 1.3.1)
timecop (= 0.3.5)
- will_paginate (= 3.0.3)
yajl-ruby (= 1.1.0)
View
6 README.md
@@ -16,17 +16,15 @@ published.
Setup
-----
-The following assumes `bake` as an alias for `bundle exec rake`.
-
bundle
- bake setup
+ bundle exec rake setup
Development
-----------
Run the test suite:
- bake
+ bundle exec rake
Run the server:
View
166 doc/README_FOR_SUSPENDERS
@@ -1,166 +0,0 @@
-This is Suspenders, the thoughtbot rails template.
-
-To create a new project, first install the suspenders gem:
-
- gem install suspenders
-
-Then run:
-
- suspenders create projectname
-
-This will create a project in ../projectname. You should then follow the
-instructions on Github to upload that project there. This creates an
-entirely new git repository, and is not meant to be used against an existing
-repo.
-
-When making a change to a project that was created via this template, consider
-whether it's a change that should be made across all projects. If so, then
-make the change in suspenders instead of your project. Note: If you don't
-have commit access to suspenders, create a github ticket and we'll review your
-suggestion.
-
-Once that's committed, you can pull into your project to get all the changes
-that have been made in suspenders since your last pull:
-
- rake git:pull:suspenders
-
-About Suspenders
-----------------
-
-Suspenders was created for use at thoughtbot, inc. (http://thoughtbot.com) as a
-baseline application setup, with reasonable default plugins that the majority
-(if not all) of our applications used, as well as best-practice configuration
-options.
-
-Suspenders currently includes a version of Rails from the 2.3 stable branch.
-You can determine the changeset with the vendor/rails/REVISION_xxxxx file.
-
-Gems (unpacked in vendor/gems, unless they are compiled gems):
---------------------------------------------------------------
-
-For record pagination:
-
- will_paginate
-
-For text formatting:
-
- RedCloth (4.2.2, not unpacked, this is a compiled gem)
-
-Form builder:
-
- Formtastic
-
-File attachments:
-
- Paperclip
-
-Basic user auth:
-
- Clearance
-
-For testing:
-
- jferris-mocha (standard mocha plus test spies)
- factory_girl (fixture replacement for test data)
- shoulda (rails test helpers and context framework)
- timecop (for time sensitive tests)
- fakeweb (for blocking HTTP calls to third-party services)
-
-Error notification:
-
- hoptoad_notifier
-
-Plugins (in vendor/plugins):
-----------------------------
-
- limerick_rake (useful rake tasks)
- validation_reflection (used by formtastic to find required fields)
- high_voltage (Rails engine for static pages)
-
-Initializers (in config/initializers)
--------------------------------------
-
- action_mailer_configs.rb
- We use SMTP by default in all applications.
-
- hoptoad.rb
- Get your API key at http://hoptoadapp.com
-
- requires.rb
- Automatically requires everything in
- lib/
- lib/extensions
- test/mocks/RAILS_ENV (Removed in Rails 2, we decided to keep it)
- Add other things you need to require in here.
-
- time_formats.rb
- Two time formats are available by default, :short_date and :long_date.
- Add other time formats here.
-
-Rake Tasks
-----------
-
-Rake tasks are contained in the limerick_rake gem.
-
- bootstrap
- Provides rake tasks for loading data into the database. These are used for
- an initial application dataset needed for production.
-
- capistrano
- Standard capistrano deployment tasks
-
-Testing
--------
-
-Testing is done utilizing Test::Unit, Shoulda, factory_girl, and mocha.
-
-factory_girl is a fixture replacement library, following the factory pattern.
-Place your factories in test/factories.rb. The fixture directory has been
-removed, as fixtures are not used.
-
-Shoulda is a pragmatic testing framework for TDD and BDD built on top of
-Test::Unit. A number of additional testing macros are provided in
-test/shoulda_macros:
-
- shoulda_have_form
- shoulda_paginate_collection
-
-Timecop is used to freeze the time for the entire test suite. It is frozen to
-the value of Time.now; that is, the time that the tests suite starts running.
-
-Deployment
-----------
-
-Deployment is done using capistrano, and deploys to a mongrel cluster, running
-under Apache.
-
-Rake tasks are provided for managing git branches which the different
-environments pull from for deploy.
-
-To push the git master to git staging branch run:
-
- rake git:push:staging
-
-To push the git staging branch to production branch run:
-
- rake git:push:production
-
-Setup your deployment environment by running:
-
- cap ENVIRONMENT deploy:setup
- (You'll be prompted for the environment's database password)
-
-Deploy to the desired environment by running:
-
- cap ENVIRONMENT deploy
-
-The default environment for deploy is staging, to deploy to staging, just run:
-
- cap deploy
-
-Mascot
-------
-
-The official Suspenders mascot is Suspenders Boy:
-
- http://media.tumblr.com/1TEAMALpseh5xzf0Jt6bcwSMo1_400.png
View
3,760 doc/diagrams.graffle
0 additions, 3,760 deletions not shown because the diff is too large. Please use a local Git client to view these changes.
View
0 tmp/.gitkeep
No changes.

0 comments on commit 7b28bfb

Please sign in to comment.