Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 131 lines (81 sloc) 4.248 kB
76e42eb @gabebw Add build status.
gabebw authored
1 # Suspenders [![Build Status](https://secure.travis-ci.org/thoughtbot/suspenders.png?branch=master)](http://travis-ci.org/thoughtbot/suspenders)
2
1eec3cc Update REAMDE
Harold Giménez authored
3 Suspenders is the base Rails application used at [thoughtbot](http://thoughtbot.com/community).
c631051 @mike-burns suspension create projectname
mike-burns authored
4
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
5 ![Suspenders boy](http://media.tumblr.com/1TEAMALpseh5xzf0Jt6bcwSMo1_400.png)
2824d87 @jasonm Pimping the suspension
jasonm authored
6
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
7 Installation
8 ------------
c631051 @mike-burns suspension create projectname
mike-burns authored
9
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
10 First install the suspenders gem:
c631051 @mike-burns suspension create projectname
mike-burns authored
11
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
12 gem install suspenders
c631051 @mike-burns suspension create projectname
mike-burns authored
13
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
14 Then run:
c631051 @mike-burns suspension create projectname
mike-burns authored
15
1eec3cc Update REAMDE
Harold Giménez authored
16 suspenders projectname
56cfb54 Edits to README (rspec and shoulda)
Harold Giménez authored
17
61c3950 @croaky [#96] Fix broken rake
croaky authored
18 This will create a Rails 3.2 app in `projectname`. This script creates a new
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
19 new git repository. It is not meant to be used against an existing repo.
c631051 @mike-burns suspension create projectname
mike-burns authored
20
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
21 Gemfile
c631051 @mike-burns suspension create projectname
mike-burns authored
22 -------
23
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
24 To see the latest and greatest gems, look at Suspenders'
1eec3cc Update REAMDE
Harold Giménez authored
25 [template/Gemfile_additions](https://github.com/thoughtbot/suspenders/blob/master/templates/Gemfile_additions),
26 which will be appended to the default generated projectname/Gemfile.
c631051 @mike-burns suspension create projectname
mike-burns authored
27
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
28 It includes application gems like:
c631051 @mike-burns suspension create projectname
mike-burns authored
29
8b5216e @brookemckim Airbrake formerly hoptoad.
brookemckim authored
30 * [Airbrake](https://github.com/airbrake/airbrake) for exception notification
354321d @mjankowski add bourbon mention and rails 3.1 details to readme
mjankowski authored
31 * [Bourbon](https://github.com/thoughtbot/bourbon) for classy sass mixins
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
32 * [Clearance](https://github.com/thoughtbot/clearance) for authentication
826c856 @croaky [#92] Add --webkit flag
croaky authored
33 * [Flutie](https://github.com/thoughtbot/flutie) for default CSS styles
34 * [Formtastic](https://github.com/justinfrench/formtastic) for better forms
35 * [Paperclip](https://github.com/thoughtbot/paperclip) for file uploads
c631051 @mike-burns suspension create projectname
mike-burns authored
36
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
37 And testing gems like:
c631051 @mike-burns suspension create projectname
mike-burns authored
38
826c856 @croaky [#92] Add --webkit flag
croaky authored
39 * [Bourne](https://github.com/thoughtbot/bourne) and Mocha for stubbing and spying
e5f966d @croaky updating docs to include switch to Capybara Webkit from Akephalos and…
croaky authored
40 * [Cucumber, Capybara, and Capybara Webkit](http://robots.thoughtbot.com/post/4583605733/capybara-webkit) for integration testing, including Javascript behavior
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
41 * [Factory Girl](https://github.com/thoughtbot/factory_girl) for easier creation of test data
826c856 @croaky [#92] Add --webkit flag
croaky authored
42 * [RSpec](https://github.com/rspec/rspec) for awesome, readable isolation testing
e5f966d @croaky updating docs to include switch to Capybara Webkit from Akephalos and…
croaky authored
43 * [Shoulda Matchers](http://github.com/thoughtbot/shoulda-matchers) for frequently needed Rails and RSpec matchers
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
44 * [Timecop](https://github.com/jtrupiano/timecop) for dealing with time
c631051 @mike-burns suspension create projectname
mike-burns authored
45
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
46 Other goodies
47 -------------
c631051 @mike-burns suspension create projectname
mike-burns authored
48
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
49 Suspenders also comes with:
56cfb54 Edits to README (rspec and shoulda)
Harold Giménez authored
50
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
51 * Rails' flashes set up and in application layout.
52 * A few nice time formats.
c6f3a61 @croaky [#95] Use Heroku-compliant asset pipeline settings
croaky authored
53 * [Heroku-compliant asset pipeline settings](https://devcenter.heroku.com/articles/rails3x-asset-pipeline-cedar/).
c631051 @mike-burns suspension create projectname
mike-burns authored
54
02a8bb0 @croaky documenting Heroku and Clearance flags
croaky authored
55 Heroku
56 ------
57
58 You can optionally create Heroku staging and production apps:
59
60 suspenders app --heroku true
61
62 This has the same effect as running:
63
a13e7cb @harlow Cedar is the default stack
harlow authored
64 heroku create app-staging --remote staging
65 heroku create app-production --remote production
02a8bb0 @croaky documenting Heroku and Clearance flags
croaky authored
66
cd3317b @croaky [#53] Add --github option to create a github repo
croaky authored
67 Github
68 ------
69
70 You can optionally create a Github repository:
71
72 suspenders app --github organization/project
73
74 This has the same effect as running:
75
76 hub create organization/project
77
02a8bb0 @croaky documenting Heroku and Clearance flags
croaky authored
78 Clearance
79 ---------
80
81 You can optionally not include Clearance:
82
83 suspenders app --clearance false
84
826c856 @croaky [#92] Add --webkit flag
croaky authored
85 Capybara Webkit
86 ---------------
87
88 You can optionally not include Capybara Webkit (which depends on QT being
89 installed on your machine):
90
91 suspenders app --webkit false
92
9900d15 @croaky adding a note in README about needing GCC to bundle gems with native …
croaky authored
93 Dependencies
94 ------------
95
96 Some gems included in Suspenders have native extensions. You should have GCC installed on your
1eec3cc Update REAMDE
Harold Giménez authored
97 machine before generating an app with Suspenders.
9900d15 @croaky adding a note in README about needing GCC to bundle gems with native …
croaky authored
98
99 If you're running OS X, we recommend the [GCC OSX installer](https://github.com/kennethreitz/osx-gcc-installer).
100
101 We use [Capybara Webkit](https://github.com/thoughtbot/capybara-webkit) for full-stack Javascript integration testing.
102 It requires you have QT installed on your machine before running Suspenders.
103
95ff9ba @mjankowski update link to QT instructions in readme
mjankowski authored
104 Instructions for installing QT on most systems are [available here](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit).
9900d15 @croaky adding a note in README about needing GCC to bundle gems with native …
croaky authored
105
107b103 @gabebw Formatting.
gabebw authored
106 PostgreSQL needs to be installed and running for the `db:create` rake task.
92413a3 @andyw8 Adding note to README about PostgreSQL dependency
andyw8 authored
107
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
108 Issues
c631051 @mike-burns suspension create projectname
mike-burns authored
109 ------
110
7b9bffc @croaky bumping the gem to 0.2.0, updating the README to include notes about …
croaky authored
111 If you have problems, please create a [Github issue](https://github.com/thoughtbot/suspenders/issues).
c631051 @mike-burns suspension create projectname
mike-burns authored
112
bbcfa8b @mike-burns Add a document describing how to contribute.
mike-burns authored
113 Contributing
114 ------------
115
116 Please see CONTRIBUTING.md for details.
117
a1c899b credits and license in the readme
Chad Pytel authored
118 Credits
119 -------
120
121 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
122
939ff58 fix the link to thoughtbot
Chad Pytel authored
123 Suspenders is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
a1c899b credits and license in the readme
Chad Pytel authored
124
125 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
126
127 License
128 -------
129
130 Suspenders is Copyright © 2008-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.
Something went wrong with that request. Please try again.