Commit 459ac50b03ea2cea7e815bc7582a7a3d5f60cc0c
1 parent
3ee9c831
Exists in
master
and in
1 other branch
vastly improved README_FOR_TEMPLATE. removed clearance as a gem since it is used…
… as a plugin. removed stray require of redcloth.
Showing
3 changed files
with
47 additions
and
30 deletions
Show diff stats
config/initializers/requires.rb
doc/README_FOR_TEMPLATE
1 | -This is Heroku Suspenders, the thoughtbot rails template modified to be used for deployment to Heroku. To create a new project, checkout this | |
2 | -repository and run: | |
1 | +This is Heroku Suspenders, the thoughtbot Rails template modified to be used for | |
2 | +deployment to Heroku. To create a new project, checkout this repository and run: | |
3 | 3 | |
4 | 4 | ./script/create_project projectname |
5 | 5 | |
6 | 6 | This will create a project in ../projectname. You should then follow the |
7 | -instructions on Github to upload that project there. This script creates an | |
7 | +instructions to deploy to Heroku. This script creates an | |
8 | 8 | entirely new git repository, and is not meant to be used against an existing |
9 | 9 | repo. |
10 | 10 | |
... | ... | @@ -18,65 +18,84 @@ About Suspenders |
18 | 18 | ---------------- |
19 | 19 | |
20 | 20 | Suspenders was created for use at thoughtbot, inc. (http://thoughtbot.com) as a |
21 | -baseline application setup, with reasonable default plugins that the majority (if not all) of our applications used, as well as best-practice configuration options. | |
21 | +baseline application setup, with intelligent defaults. | |
22 | 22 | |
23 | -Suspenders currently includes Rails 2.3.2 | |
23 | +Suspenders currently runs on Rails 2.3.2. | |
24 | 24 | |
25 | -Gems (unpacked in vendor/gems): | |
26 | -------------------------------- | |
25 | +Gems (in .gems): | |
26 | +---------------- | |
27 | 27 | |
28 | -For record pagination: | |
28 | +For testing: | |
29 | 29 | |
30 | - will_paginate | |
30 | + mocha | |
31 | + thoughtbot-factory_girl | |
32 | + thoughtbot-shoulda | |
31 | 33 | |
32 | -For text formatting: | |
34 | +For file uploads: | |
33 | 35 | |
34 | - RedCloth | |
36 | + thoughtbot-paperclip | |
37 | + right_aws | |
35 | 38 | |
36 | -For testing: | |
39 | +For email through SMTP (particularly Gmail): | |
37 | 40 | |
38 | - mocha | |
39 | - factory_girl | |
40 | - shoulda | |
41 | + ambethia-smtp-tls | |
42 | + | |
43 | +For background processing: | |
44 | + | |
45 | + tobi-delayed_job | |
41 | 46 | |
42 | 47 | Plugins (in vendor/plugins): |
43 | 48 | ---------------------------- |
44 | 49 | |
50 | +For authentication: | |
51 | + | |
52 | + thoughtbot-clearance | |
53 | + | |
54 | +For exception notification: | |
55 | + | |
45 | 56 | hoptoad_notifier |
57 | + | |
58 | +For models, controllers, helpers, & features generators: | |
59 | + | |
60 | + coulda | |
61 | + | |
62 | +For rake tasks: | |
63 | + | |
46 | 64 | limerick_rake |
47 | 65 | |
48 | 66 | Initializers (in config/initializers) |
49 | 67 | ------------------------------------- |
50 | 68 | |
51 | -We use SMTP by default in all applications. | |
69 | +For email through SMTP (particularly Gmail): | |
52 | 70 | |
53 | - action_mailer_configs.rb | |
71 | + mail.rb | |
54 | 72 | |
55 | 73 | Get your API key at http://hoptoadapp.com |
56 | 74 | |
57 | 75 | hoptoad.rb |
58 | 76 | |
59 | -Two time formats are available by default, :short_date and :long_date. Add other time formats here. | |
77 | +Get your free Google Analytics account at http://www.google.com/analytics | |
60 | 78 | |
61 | - time_formats.rb | |
79 | + google_anayltics.rb | |
62 | 80 | |
63 | -Rake Tasks | |
64 | ----------- | |
81 | +For Delayed Job settings: | |
65 | 82 | |
66 | -Rake tasks are contained in the limerick_rake gem. Provides rake tasks for loading data into the database. These are used for an initial application dataset needed for production. | |
83 | + delayed_job.rb | |
67 | 84 | |
68 | - bootstrap | |
85 | +Two time formats are available by default, :short_date and :long_date. Add other time formats here. | |
86 | + | |
87 | + time_formats.rb | |
69 | 88 | |
70 | 89 | Testing |
71 | 90 | ------- |
72 | 91 | |
73 | 92 | Testing is done utilizing Test::Unit, Shoulda, factory_girl, and mocha. |
74 | 93 | |
75 | -factory_girl is a fixture replacement library, following the factory pattern. Place your | |
76 | -factories in test/factories.rb. The fixture directory has been removed, as fixtures are not | |
77 | -used. | |
94 | +factory_girl is a fixture replacement library, following the factory pattern. | |
95 | +Place your factories in test/factories.rb. The fixture directory has been | |
96 | +removed, as fixtures are not used. | |
78 | 97 | |
79 | -Shoulda is a pragmatic testing framework for TDD and BDD built on top of Test::Unit. | |
98 | +Shoulda is a pragmatic testing framework for TDD built on top of Test::Unit. | |
80 | 99 | |
81 | 100 | jferris-mocha --version '0.9.5.0.1241126838' --source gems.github.com |
82 | 101 | thoughtbot-factory_girl --version '>= 1.2.0' --source gems.github.com |
... | ... | @@ -88,3 +107,4 @@ Mascot |
88 | 107 | The official Suspenders mascot is Suspenders Boy: |
89 | 108 | |
90 | 109 | http://media.tumblr.com/1TEAMALpseh5xzf0Jt6bcwSMo1_400.png |
110 | + | ... | ... |