highgroove_generator 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +11 -2
- data/lib/highgroove-generator/version.rb +1 -1
- data/lib/highgroove_command.rb +7 -0
- data/lib/templates/README.md +57 -0
- metadata +11 -10
data/README.md
CHANGED
@@ -2,6 +2,12 @@
|
|
2
2
|
|
3
3
|
Generate Rails projects the way we like them.
|
4
4
|
|
5
|
+
## Dependencies
|
6
|
+
|
7
|
+
The capybara-webkit gem which the generator installs dependes on QT
|
8
|
+
being installed. On OSX with Hombrew run ```brew install qt``` to make
|
9
|
+
sure QT is installed.
|
10
|
+
|
5
11
|
## Installation
|
6
12
|
|
7
13
|
```bash
|
@@ -17,8 +23,11 @@ Generate Rails projects the way we like them.
|
|
17
23
|
# specify the database type
|
18
24
|
highgroove new NAME --database=DATABASE
|
19
25
|
|
20
|
-
#
|
21
|
-
highgroove
|
26
|
+
# Don't create a heroku app
|
27
|
+
highgroove new NAME --host=none
|
28
|
+
|
29
|
+
# get help
|
30
|
+
highgroove help
|
22
31
|
```
|
23
32
|
|
24
33
|
## Contributing
|
data/lib/highgroove_command.rb
CHANGED
@@ -63,6 +63,8 @@ SimpleCov.start
|
|
63
63
|
end
|
64
64
|
append_to_file '.gitignore', "\ncoverage\n.rvmrc"
|
65
65
|
remove_file 'public/index.html'
|
66
|
+
remove_file 'README.rdoc'
|
67
|
+
remove_file 'doc/README_FOR_APP'
|
66
68
|
gsub_file 'config/database.yml', /username: .*$/, 'username:'
|
67
69
|
run 'rake db:create'
|
68
70
|
run 'git add .'
|
@@ -72,5 +74,10 @@ SimpleCov.start
|
|
72
74
|
run 'git push heroku master'
|
73
75
|
end
|
74
76
|
end
|
77
|
+
copy_file "templates/README.md", "#{name}/README.md"
|
78
|
+
end
|
79
|
+
|
80
|
+
def self.source_root
|
81
|
+
File.dirname(__FILE__)
|
75
82
|
end
|
76
83
|
end
|
@@ -0,0 +1,57 @@
|
|
1
|
+
# <Project Name>
|
2
|
+
|
3
|
+
## Getting Setup
|
4
|
+
|
5
|
+
```bash
|
6
|
+
# Checkout the repo
|
7
|
+
git clone git@github.com:highgroove/<project>.git
|
8
|
+
|
9
|
+
# Install rvm and create a gemset
|
10
|
+
rvm install 1.9.2 && rvm gemset create <project>
|
11
|
+
|
12
|
+
# Install gem dependencies
|
13
|
+
gem install bundler
|
14
|
+
bundle install
|
15
|
+
|
16
|
+
# Install other dependencies
|
17
|
+
# ex: brew install <list dependencies here. e.g. postgres, redis, etc.>
|
18
|
+
|
19
|
+
# Get the database ready
|
20
|
+
# ex: bundle exec rake db:create:all db:schema:load db:test:prepare
|
21
|
+
|
22
|
+
# Start the app and other processes some how e.g. `bundle exec foreman start`
|
23
|
+
|
24
|
+
# setup other services like Solr, Redis, etc...
|
25
|
+
```
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
### Database setup
|
30
|
+
|
31
|
+
For example:
|
32
|
+
|
33
|
+
Grab the production database
|
34
|
+
|
35
|
+
```bash
|
36
|
+
heroku pgbackups:capture --expire
|
37
|
+
curl -o latest.dump `heroku pgbackups:url`
|
38
|
+
pg_restore -h localhost --verbose --clean --no-acl --no-owner -d
|
39
|
+
<project>_development latest.dump
|
40
|
+
rm latest.dump
|
41
|
+
```
|
42
|
+
|
43
|
+
|
44
|
+
### Testing
|
45
|
+
|
46
|
+
Explain how to run the test-suite here
|
47
|
+
|
48
|
+
## Production
|
49
|
+
|
50
|
+
* Explain how to deploy here
|
51
|
+
* Explain any addons required (for example Heroku addons)
|
52
|
+
* Explain external services being used e.g. Mailchimp, Mandrill, NewRelic, etc.
|
53
|
+
|
54
|
+
## Architecture
|
55
|
+
|
56
|
+
* List any salient architecture notes. This should be super high-level but
|
57
|
+
explain to future devs how things fit together
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: highgroove_generator
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.3.0
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,11 +9,11 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2012-06-
|
12
|
+
date: 2012-06-06 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: rails
|
16
|
-
requirement: &
|
16
|
+
requirement: &70320916959480 !ruby/object:Gem::Requirement
|
17
17
|
none: false
|
18
18
|
requirements:
|
19
19
|
- - ! '>='
|
@@ -21,10 +21,10 @@ dependencies:
|
|
21
21
|
version: 3.2.0
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
|
-
version_requirements: *
|
24
|
+
version_requirements: *70320916959480
|
25
25
|
- !ruby/object:Gem::Dependency
|
26
26
|
name: thor
|
27
|
-
requirement: &
|
27
|
+
requirement: &70320916957660 !ruby/object:Gem::Requirement
|
28
28
|
none: false
|
29
29
|
requirements:
|
30
30
|
- - ! '>='
|
@@ -32,10 +32,10 @@ dependencies:
|
|
32
32
|
version: '0'
|
33
33
|
type: :runtime
|
34
34
|
prerelease: false
|
35
|
-
version_requirements: *
|
35
|
+
version_requirements: *70320916957660
|
36
36
|
- !ruby/object:Gem::Dependency
|
37
37
|
name: heroku
|
38
|
-
requirement: &
|
38
|
+
requirement: &70320916954640 !ruby/object:Gem::Requirement
|
39
39
|
none: false
|
40
40
|
requirements:
|
41
41
|
- - ! '>='
|
@@ -43,7 +43,7 @@ dependencies:
|
|
43
43
|
version: '0'
|
44
44
|
type: :runtime
|
45
45
|
prerelease: false
|
46
|
-
version_requirements: *
|
46
|
+
version_requirements: *70320916954640
|
47
47
|
description: Tool to generate a rails project ready for development
|
48
48
|
email:
|
49
49
|
- aubrey.c.rhodes@gmail.com
|
@@ -61,6 +61,7 @@ files:
|
|
61
61
|
- highgroove-generator.gemspec
|
62
62
|
- lib/highgroove-generator/version.rb
|
63
63
|
- lib/highgroove_command.rb
|
64
|
+
- lib/templates/README.md
|
64
65
|
homepage: http://github.com/highgroove/highgroove-generator
|
65
66
|
licenses: []
|
66
67
|
post_install_message:
|
@@ -75,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
75
76
|
version: '0'
|
76
77
|
segments:
|
77
78
|
- 0
|
78
|
-
hash:
|
79
|
+
hash: 4474722990228110852
|
79
80
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
80
81
|
none: false
|
81
82
|
requirements:
|
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
84
85
|
version: '0'
|
85
86
|
segments:
|
86
87
|
- 0
|
87
|
-
hash:
|
88
|
+
hash: 4474722990228110852
|
88
89
|
requirements: []
|
89
90
|
rubyforge_project:
|
90
91
|
rubygems_version: 1.8.15
|