This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
-
System dependencies
-
Configuration
Creating an admin - run rails console Admin.create({:email => “email@email.com”, :password => “password”, :password_confirmation => “password}).save
-
Database creation
-
Database initialization
-
How to run the test suite
run ‘rspec’ to run the tests run ‘guard’ to monitor file changes and run the tests manually
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
…
-
Devise
Some setup you must do manually if you haven’t yet:
1. Ensure you have defined default url options in your environments files. Here
is an example of default_url_options appropriate for a development environment
in config/environments/development.rb:
config.action_mailer.default_url_options = { host: 'localhost:3000' }
In production, :host should be set to the actual host of your application.
2. Ensure you have defined root_url to *something* in your config/routes.rb.
For example:
root to: "home#index"
3. Ensure you have flash messages in app/views/layouts/application.html.erb.
For example:
<p class="notice"><%= notice %></p>
<p class="alert"><%= alert %></p>
4. If you are deploying on Heroku with Rails 3.2 only, you may want to set:
config.assets.initialize_on_precompile = false
On config/application.rb forcing your application to not access the DB
or load models when precompiling your assets.
5. You can copy Devise views (for customization) to your app by running:
rails g devise:views
Please feel free to use a different markup language if you do not plan to run rake doc:app.