Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

272 lines (262 sloc) 11.483 kb
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Recipes for the Rails Apps Composer Gem &#183; RailsApps</title>
<link href="https://plus.google.com/u/0/b/117374718581973393536/117374718581973393536/posts/" rel="publisher" />
<link rel="stylesheet" href="http://railsapps.github.com/css/bootstrap.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="http://railsapps.github.com/css/screen.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="http://railsapps.github.com/css/gollum.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="http://railsapps.github.com/css/site.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="http://railsapps.github.com/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="http://railsapps.github.com/javascript/jquery.text_selection-1.0.0.min.js" type="text/javascript"></script>
<script src="http://railsapps.github.com/javascript/jquery.previewable_comment_form.js" type="text/javascript"></script>
<script src="http://railsapps.github.com/javascript/jquery.tabs.js" type="text/javascript"></script>
<script src="http://railsapps.github.com/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 class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a href="http://railsapps.github.com/" class="brand">RailsApps Project</a>
<ul class="pull-right nav">
<li><a href="http://blog.railsapps.org/" class="twitter">Blog</a></li>
<li><a href="http://twitter.com/rails_apps" class="twitter">Twitter</a></li>
<li><a href="https://plus.google.com/117374718581973393536" class="google">Google +</a></li>
<li><a href="https://github.com/RailsApps" class="github">GitHub Repository</a></li>
</ul>
</div>
</div>
</div>
<div class="container">
<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/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/extras.rb">extras.rb</a> </td>
<td> ban spiders, add rails-footnotes </td>
<td> none </td>
<td> 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 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/html5.rb">html5.rb</a> </td>
<td> updates application layout, adds front-end framework for HTML5 and <span class="caps">CSS</span> </td>
<td> <span class="caps">ERB</span> or Haml </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/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 and Issues</h2>
</div>
<p>Is this helpful? Please add a comment below. Your encouragement fuels the project.</p>
<p>Did you find an error? Or couldn't get something to work? For the example apps and tutorials, please create a GitHub issue in the repository for the example app. Creating a GitHub issue is the best way to make sure a problem is investigated and fixed.</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
/* * * 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" -->
<div class="footer row">
<div class="span4">
<h3>Credits</h3>
<p><a href="http://danielkehoe.com/">Daniel Kehoe</a> initiated the <a href="http://railsapps.github.com/">RailsApps Project</a>. Thanks to all the users and contributors.</p>
</div>
<div class="span4">
<h3>Wiki</h3>
<p>Corrections? Additions? You can edit this page <a href="https://github.com/RailsApps/railsapps.github.com/wiki/_pages">on the wiki</a>.</p>
</div>
<div class="span4">
<h3>Last edit</h3>
<p>by <b>Daniel Kehoe</b>, 2012-07-20 23:08:42</p>
</div>
</div>
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.