You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.textile
+25-21Lines changed: 25 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
h1. Rails 3 + Devise + RSpec + Cucumber
2
2
3
-
This is an example application for Rails 3.0 or Rails 3.1 that shows how to use "Devise":http://github.com/plataformatec/devise with "RSpec":http://rspec.info/ and "Cucumber":http://cukes.info/. Devise gives you ready-made authentication and user management. RSpec is a popular alternative to the Test::Unit testing framework. Cucumber is often used with RSpec for Behaviour Driven Development.
3
+
This is an example application for Rails 3.1 that shows how to use "Devise":http://github.com/plataformatec/devise with "RSpec":http://rspec.info/ and "Cucumber":http://cukes.info/. Devise gives you ready-made authentication and user management. RSpec is a popular alternative to the Test::Unit testing framework. Cucumber is often used with RSpec for Behaviour Driven Development.
4
4
5
5
Best of all, there's a "detailed tutorial":https://github.com/railsapps/rails3-devise-rspec-cucumber/wiki/Tutorial (walk-through) to show how it's built.
6
6
@@ -16,11 +16,11 @@ Follow the project on Twitter: "http://twitter.com/rails_apps":http://twitter.co
A complete walkthrough tutorial for Rails 3.0 or Rails 3.1 is available on the GitHub wiki:
19
+
A complete walkthrough tutorial for Rails 3.1 is available on the GitHub wiki:
20
20
21
21
h4. "View the Tutorial":https://github.com/railsapps/rails3-devise-rspec-cucumber/wiki/Tutorial
22
22
23
-
The tutorial documents each step to follow to create the application. Every step is documented concisely, so a complete beginner can create this application without any additional knowledge. However, no explanation is offered for any of the steps, so if you are a beginner, you’re advised to look for an introduction to Rails elsewhere. See a list of "Rails books and references":http://railsapps.github.com/rails-books.html for recommended reading.
23
+
The tutorial documents each step to follow to create the application. Every step is documented concisely, so a complete beginner can create this application without any additional knowledge. However, no explanation is offered for any of the steps, so if you are a beginner, you’re advised to look for an introduction to Rails elsewhere. See a list of "recommended books and online resources for learning Rails":http://railsapps.github.com/best-recommended-learning-rails-books-resources.html.
24
24
25
25
If you simply wish to modify the application for your own project, you can download the application and set it up as described below, without following the tutorial.
26
26
@@ -32,21 +32,23 @@ h4. Similar Examples and Tutorials
32
32
33
33
If you'd like to use the Mongoid ORM with the MongoDB datastore instead of ActiveRecord and a SQLite database, see the "rails3-mongoid-devise":https://github.com/railsapps/rails3-mongoid-devise example app and tutorial. Mongoid makes development quicker without schemas or migrations. The "rails3-mongoid-devise":https://github.com/railsapps/rails3-mongoid-devise example app and tutorial shows how to set up Devise and Mongoid with RSpec and Cucumber.
34
34
35
-
See a list of similar "Rails examples, tutorials, and starter apps":http://railsapps.github.com/rails-examples-tutorials.html.
35
+
See an expanded list of more "Rails examples, tutorials, and starter apps":http://railsapps.github.com/rails-examples-tutorials.html.
36
36
37
37
h2. Dependencies
38
38
39
39
Before running this app, you need to install
40
40
41
-
* The Ruby language (version 1.8.7 or 1.9.2)
42
-
* Rails 3.0 or Rails 3.1
41
+
* The Ruby language (version 1.9.2)
42
+
* Rails 3.1
43
43
44
-
I recommend installing rvm, the "Ruby Version Manager":http://rvm.beginrescueend.com/, to manage multiple versions of Rails.
44
+
If you must use an earlier version of Rails, this repository contains a branch for Rails 3.0.7.
45
45
46
46
Check that appropriate versions of Ruby and Rails are installed in your development environment:
47
47
@$ ruby -v@
48
48
@$ rails -v@
49
49
50
+
See "Managing Rails Versions and Gems":http://railsapps.github.com/managing-rails-versions-gems.html for detailed instructions and advice.
51
+
50
52
h2. Getting the Application
51
53
52
54
You have several options for getting the code.
@@ -55,13 +57,13 @@ h4. Downloading the Code
55
57
56
58
If you simply wish to examine the example code, you can download the code ("clone the repository") with the command
The source code is managed with Git (a version control system). You'll need Git on your machine (install it from "http://git-scm.com/":http://git-scm.com/).
61
63
62
64
h4. Using the Ready-Made Application Template
63
65
64
-
You can use an application template to generate a new version of the example app. You’ll find an application template for this app in the "RailsApps/rails3-application-templates":https://github.com/RailsApps/rails3-application-templates repository.
66
+
You can use an application template to generate a new version of the example app. You’ll find an application template for this app in the "Rails Application Templates":https://github.com/RailsApps/rails3-application-templates repository.
65
67
66
68
To build the "rails3-devise-rspec-cucumber" example application, run the command:
67
69
@@ -86,7 +88,7 @@ The application generator template will ask you for your preferences:
86
88
87
89
h4. Use "Recipes" to Customize an Application Template
88
90
89
-
The "tutorial":https://github.com/railsapps/rails3-devise-rspec-cucumber/wiki/Tutorial shows how a customized application template can be assembled from "recipes." The application template was created using the "rails_apps_composer":https://github.com/RailsApps/rails_apps_composer gem which provides a convenient way to assemble a reusable application template by selecting various "recipes" for popular Rails development packages.
91
+
The "tutorial":https://github.com/railsapps/rails3-devise-rspec-cucumber/wiki/Tutorial shows how a customized application template can be assembled from "recipes." The application template was created using the "Rails Apps Composer":https://github.com/RailsApps/rails_apps_composer gem which provides a convenient way to assemble a reusable application template by selecting various "recipes" for popular Rails development packages.
90
92
91
93
h4. Please Remember: Edit the README
92
94
@@ -96,17 +98,19 @@ h2. Getting Started
96
98
97
99
h3. About Required Gems
98
100
99
-
The application uses the following gems. I recommend checking for newer versions of these gems before proceeding:
101
+
The application uses the following gems:
102
+
103
+
* rails
104
+
* rspec-rails
105
+
* database_cleaner
106
+
* factory_girl_rails
107
+
* cucumber-rails
108
+
* capybara
109
+
* devise
100
110
101
-
* rails "(check rubygems.org for a newer gem)":http://rubygems.org/gems/rails
102
-
* devise "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/devise
103
-
* rspec-rails "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/rspec-rails
104
-
* database_cleaner "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/database_cleaner
105
-
* factory_girl_rails "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/factory_girl_rails
106
-
* cucumber-rails "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/cucumber-rails
107
-
* capybara "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/capybara
111
+
See an example "Rails 3.1 Gemfile":http://railsapps.github.com/rails-3-1-example-gemfile.html.
108
112
109
-
The app has been tested with the indicated versions. If you are able to build the app with a newer gem, please create an "issue":http://github.com/railsapps/rails3-devise-rspec-cucumber/issues on GitHub and I will update the app.
113
+
See "Managing Rails Versions and Gems":http://railsapps.github.com/managing-rails-versions-gems.html for advice and details.
110
114
111
115
h3. Install the Required Gems
112
116
@@ -122,7 +126,7 @@ Keep in mind that you have installed these gems locally. When you deploy the app
122
126
123
127
h3. Set Up Configuration for Devise
124
128
125
-
This app uses Devise for user management and authentication. Devise is at "http://github.com/plataformatec/devise":http://github.com/plataformatec/devise.
129
+
This app uses "Devise":http://github.com/plataformatec/devise for user management and authentication.
126
130
127
131
You can modify the configuration file for Devise if you want to use something other than the defaults:
128
132
@@ -179,7 +183,7 @@ You should delete or change the pre-configured logins before you deploy your app
179
183
180
184
h2. Deploy to Heroku
181
185
182
-
For your convenience, here are "instructions for deploying your app to Heroku":http://railsapps.github.com/rails-heroku-tutorial.html. Heroku provides low cost, easily configured Rails application hosting.
186
+
For your convenience, here are instructions for "deploying your app to Heroku":http://railsapps.github.com/rails-heroku-tutorial.html. Heroku provides low cost, easily configured Rails application hosting.
0 commit comments