highgroove_generator 0.2.0 → 0.3.0

data/README.md

@@ -2,6 +2,12 @@
 
 Generate Rails projects the way we like them.
 
+## Dependencies
+
+The capybara-webkit gem which the generator installs dependes on QT
+being installed. On OSX with Hombrew run ```brew install qt``` to make
+sure QT is installed.
+
 ## Installation
 
 ```bash
@@ -17,8 +23,11 @@ Generate Rails projects the way we like them.
  # specify the database type
  highgroove new NAME --database=DATABASE
 
-# get help
-highgroove help
+ # Don't create a heroku app
+ highgroove new NAME --host=none
+
+ # get help
+ highgroove help
 ```
 
 ## Contributing

data/lib/highgroove-generator/version.rb

@@ -1,5 +1,5 @@
 module Highgroove
   module Generator
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/highgroove_command.rb

@@ -63,6 +63,8 @@ SimpleCov.start
       end
       append_to_file '.gitignore', "\ncoverage\n.rvmrc"
       remove_file 'public/index.html'
+      remove_file 'README.rdoc'
+      remove_file 'doc/README_FOR_APP'
       gsub_file 'config/database.yml', /username: .*$/, 'username:'
       run 'rake db:create'
       run 'git add .'
@@ -72,5 +74,10 @@ SimpleCov.start
         run 'git push heroku master'
       end
     end
+    copy_file "templates/README.md", "#{name}/README.md"
+  end
+
+  def self.source_root
+    File.dirname(__FILE__)
   end
 end

data/lib/templates/README.md

@@ -0,0 +1,57 @@
+# <Project Name>
+
+## Getting Setup
+
+```bash
+# Checkout the repo
+git clone git@github.com:highgroove/<project>.git
+
+# Install rvm and create a gemset
+rvm install 1.9.2 && rvm gemset create <project>
+
+# Install gem dependencies
+gem install bundler
+bundle install
+
+# Install other dependencies
+# ex: brew install <list dependencies here. e.g. postgres, redis, etc.>
+
+# Get the database ready
+# ex: bundle exec rake db:create:all db:schema:load db:test:prepare
+
+# Start the app and other processes some how e.g. `bundle exec foreman start`
+
+# setup other services like Solr, Redis, etc...
+```
+
+## Development
+
+### Database setup
+
+For example:
+
+Grab the production database
+
+```bash
+heroku pgbackups:capture --expire
+curl -o latest.dump `heroku pgbackups:url`
+pg_restore -h localhost --verbose --clean --no-acl --no-owner -d
+<project>_development latest.dump
+rm latest.dump
+```
+
+
+### Testing
+
+Explain how to run the test-suite here
+
+## Production
+
+* Explain how to deploy here
+* Explain any addons required (for example Heroku addons)
+* Explain external services being used e.g. Mailchimp, Mandrill, NewRelic, etc.
+
+## Architecture
+
+* List any salient architecture notes.  This should be super high-level but
+  explain to future devs how things fit together

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: highgroove_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-04 00:00:00.000000000 Z
+date: 2012-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70267888073960 !ruby/object:Gem::Requirement
+  requirement: &70320916959480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70267888073960
+  version_requirements: *70320916959480
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70267888088540 !ruby/object:Gem::Requirement
+  requirement: &70320916957660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70267888088540
+  version_requirements: *70320916957660
 - !ruby/object:Gem::Dependency
   name: heroku
-  requirement: &70267888087520 !ruby/object:Gem::Requirement
+  requirement: &70320916954640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70267888087520
+  version_requirements: *70320916954640
 description: Tool to generate a rails project ready for development
 email:
 - aubrey.c.rhodes@gmail.com
@@ -61,6 +61,7 @@ files:
 - highgroove-generator.gemspec
 - lib/highgroove-generator/version.rb
 - lib/highgroove_command.rb
+- lib/templates/README.md
 homepage: http://github.com/highgroove/highgroove-generator
 licenses: []
 post_install_message: 
@@ -75,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2266280702427817390
+      hash: 4474722990228110852
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2266280702427817390
+      hash: 4474722990228110852
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.15