/
rails-apps-recipes.html
266 lines (264 loc) · 13.1 KB
/
rails-apps-recipes.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Recipes for the Rails Apps Composer Gem</title>
<link rel="stylesheet" href="/css/screen.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="/css/gollum.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="/css/syntax.css" type="text/css" charset="utf-8" />
<script src="http://code.jquery.com/jquery-1.6.min.js" type="text/javascript"></script>
<script src="/javascript/jquery.text_selection-1.0.0.min.js" type="text/javascript"></script>
<script src="/javascript/jquery.previewable_comment_form.js" type="text/javascript"></script>
<script src="/javascript/jquery.tabs.js" type="text/javascript"></script>
<script src="/javascript/gollum.js" type="text/javascript"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-5109366-14']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id="main">
<div class="site">
<div id="guides">
<div class="guide">
<div class="main">
<div class="actions">
<a href="http://railsapps.github.com/"><img src="http://railsapps.github.com/images/rails-36x36.jpg" title="Home" alt="Home"></a>
<a href="http://railsapps.github.com/">Rails Apps</a>
<a href="https://github.com/RailsApps">GitHub Repository</a>
</div><!-- class="actions" -->
<h1>Recipes for the Rails Apps Composer Gem</h1>
<div class="content wikistyle gollum textile">
<h1>Recipes for the Rails Apps Composer Gem</h1>
<p>The <a href="https://github.com/RailsApps/rails_apps_composer">Rails Apps Composer</a> gem is used to create the example apps from the <a href="http://railsapps.github.com/">Rails Apps</a> repository.</p>
<p>The Rails Apps Composer gem provides recipes to create Rails application templates you can use to generate Rails starter apps. Here’s a list of some of the recipes.</p>
<p>For an up-to-date list, browse the repository <a href="https://github.com/RailsApps/rails_apps_composer/tree/master/recipes">recipes directory</a>.</p>
<p>Got a correction or addition? Update the <a href="https://github.com/RailsApps/railsapps.github.com/wiki/rails-apps-recipes">wiki page</a> or create an <a href="https://github.com/RailsApps/railsapps.github.com/issues">issue</a> to alert me.</p>
<h2>The Recipes</h2>
<p>The following recipes were used to create the application templates.</p>
<h4>Recipes for General Use</h4>
<table>
<tr><th>File </th>
<th></th>
<th>Dependencies </th>
<th>Authors </th>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/action_mailer.rb">action_mailer.rb</a> </td>
<td> Changes ActionMailer defaults </td>
<td> none </td>
<td> dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/ban_spiders.rb">ban_spiders.rb</a> </td>
<td> Ban spiders from your site by changing robots.txt </td>
<td> none </td>
<td> dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/cleanup.rb">cleanup.rb</a> </td>
<td> Remove unnecessary files, add READMEs </td>
<td> none </td>
<td> fnichol, dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/git.rb">git.rb</a> </td>
<td> Add a gitignore file, initialize new Git repo </td>
<td> Git </td>
<td> fnichol, dkehoe </td>
</tr>
</table><h4>Recipes for Testing and <span class="caps">BDD</span></h4>
<table>
<tr><th>File </th>
<th></th>
<th>Dependencies </th>
<th>Authors </th>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/rspec.rb">rspec.rb</a> </td>
<td> Install RSpec </td>
<td> none </td>
<td> rbrooker, dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/cucumber.rb">cucumber.rb</a> </td>
<td> Install Cucumber </td>
<td> none </td>
<td> rbrooker, dkehoe </td>
</tr>
</table><h4>Recipes for Mongoid</h4>
<table>
<tr><th>File </th>
<th></th>
<th>Dependencies </th>
<th>Authors </th>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/mongoid.rb">mongoid.rb</a> </td>
<td> Installs Mongoid with the bson_ext gem </td>
<td> Mongoid </td>
<td> dkehoe </td>
</tr>
</table><h4>Recipes for jQuery</h4>
<table>
<tr><th>File </th>
<th></th>
<th>Dependencies </th>
<th>Authors </th>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/jquery_fix.rb">jquery.rb</a> </td>
<td> Installs jQuery </td>
<td> none </td>
<td> dkehoe </td>
</tr>
</table><h4>Recipes for Devise</h4>
<table>
<tr><th>File </th>
<th></th>
<th>Dependencies </th>
<th>Authors </th>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/devise.rb">devise.rb</a> </td>
<td> Installs Devise </td>
<td> none </td>
<td> dkehoe </td>
</tr>
</table><h4>Recipes for OmniAuth</h4>
<table>
<tr><th>File </th>
<th></th>
<th>Dependencies </th>
<th>Authors </th>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/omniauth.rb">omniauth.rb</a> </td>
<td> OmniAuth for authentication </td>
<td> none </td>
<td> dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/omniauth_email.rb">omniauth_email.rb</a> </td>
<td> Requests a new uer’s email address when authenticating with Twitter, etc. </td>
<td> OmniAuth </td>
<td> dkehoe </td>
</tr>
</table><h4>Recipes for Haml</h4>
<table>
<tr><th>File </th>
<th></th>
<th>Dependencies </th>
<th>Authors </th>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/haml.rb">haml.rb</a> </td>
<td> Installs Haml </td>
<td> none </td>
<td> dkehoe </td>
</tr>
</table><h4>Recipes for the Application Layout</h4>
<table>
<tr><th>File </th>
<th></th>
<th>Dependencies </th>
<th>Authors </th>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/application_layout.rb">application_layout.rb</a> </td>
<td> Adds application layout with flash messages </td>
<td> <span class="caps">ERB</span> or Haml </td>
<td> dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/css_setup.rb">css_setup.rb</a> </td>
<td> Add a stylesheet with styles for a horizontal menu and flash messages </td>
<td> none </td>
<td> dkehoe </td>
</tr>
</table><h4>Recipes for the Example Apps</h4>
<table>
<tr><th>File </th>
<th></th>
<th>Dependencies </th>
<th>Authors </th>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/add_user.rb">add_user.rb</a> </td>
<td> adds User model for use with OmniAuth or Devise </td>
<td> none </td>
<td> dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/_navigation.rb">navigation.rb</a> </td>
<td> Add navigation links to the default application layout </td>
<td> none </td>
<td> dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/devise_navigation.rb">devise_navigation.rb</a> </td>
<td> Add navigation links to the default application layout </td>
<td> Devise </td>
<td> dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/home_page.rb">home_page.rb</a> </td>
<td> Create a home controller, route, and simple view </td>
<td> <span class="caps">ERB</span> or Haml </td>
<td> dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/home_page_users.rb">home_page_users.rb</a> </td>
<td> Modify a home page to display a list of users </td>
<td> Home controller, User model, <span class="caps">ERB</span> or Haml </td>
<td> dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/seed_database.rb">seed_database.rb</a> </td>
<td> Adds a db/seeds.rb file to initialize a database </td>
<td> none </td>
<td> dkehoe </td>
</tr>
<tr><td> <a href="https://github.com/RailsApps/rails_apps_composer/blob/master/recipes/users_page.rb">users_page.rb</a> </td>
<td> Add a home page containing links to User pages </td>
<td> User model, <span class="caps">ERB</span> or Haml </td>
<td> dkehoe </td>
</tr>
</table>
</div><!-- class="content" -->
<div class="comments">
<div class="content wikistyle gollum">
<h2>Comments</h2>
</div>
<p>Is this helpful? Please "like" below. Question or suggestion? Please add a comment below. Got a correction or addition? You can edit this page <a href="https://github.com/railsapps/railsapps.github.com/wiki/_pages">on the wiki</a> or create a <a href="https://github.com/RailsApps/railsapps.github.com/issues">GitHub issue</a> to alert me.</p>
<div id="disqus_thread"></div>
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = 'railsapps'; // required: replace example with your forum shortname
// The following are highly recommended additional parameters.
// var disqus_identifier = 'rails-apps-recipes.html';
// var disqus_url = 'http://railsapps.github.com/rails-apps-recipes.html';
/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
</div><!-- class="comments" -->
<br />
<br />
<div class="credits">
<div class="content wikistyle gollum">
<h2>Credits</h2>
</div>
<p>Daniel Kehoe (<a href="http://danielkehoe.com/">http://danielkehoe.com/</a>) initiated the project and wrote some examples and tutorials.</p>
<p>Your contributions are welcome!</p>
</div><!-- class="credits" -->
<div class="admin">
<small>Corrections? Additions? You can edit this page <a href="https://github.com/railsapps/railsapps.github.com/wiki/_pages">on the wiki</a>.</small>
<div style="float: right;">
<small>Last edited by <b>Daniel Kehoe</b>, 2011-09-01 12:24:10</small>
</div>
</div><!-- class="admin" -->
</div><!-- class="main" -->
</div><!-- class="guide" -->
</div><!-- id="guides" -->
</div><!-- class="site" -->
</div><!-- id="main" -->
<!-- MixPanel analytics -->
<script type='text/javascript'> var mp_protocol = (('https:' == document.location.protocol) ? 'https://' : 'http://'); document.write(unescape('%3Cscript src="' + mp_protocol + 'api.mixpanel.com/site_media/js/api/mixpanel.js" type="text/javascript"%3E%3C/script%3E')); </script> <script type='text/javascript'> try { var mpmetrics = new MixpanelLib('b1cf97418f8c5b129847e8a52edbae68'); } catch(err) { null_fn = function () {}; var mpmetrics = { track: null_fn, track_funnel: null_fn, register: null_fn, register_once: null_fn, register_funnel: null_fn }; } </script>
<!-- Clicky analytics -->
<script src="//static.getclicky.com/js" type="text/javascript"></script>
<script type="text/javascript">try{ clicky.init(66423523); }catch(e){}</script>
<noscript><p><img alt="Clicky" width="1" height="1" src="//in.getclicky.com/66423523ns.gif" /></p></noscript>
</body>
</html>