Skip to content
This repository has been archived by the owner on Feb 24, 2021. It is now read-only.

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
recurser committed Oct 20, 2010
1 parent 6529980 commit f7448d8
Show file tree
Hide file tree
Showing 9 changed files with 122 additions and 452 deletions.
87 changes: 81 additions & 6 deletions README.textile
Expand Up @@ -33,20 +33,25 @@ $ rake db:setup
Finally, run the local development server to try it out :

{% highlight bash %}
$ rails server
$ rails s
{% endhighlight %}

The demo application should now be available at "http://localhost:3000/":http://localhost:3000/.

h2. What's Included?

We've tried to create a sensible base to start build your Rails 3 applications off of, with all the packages we generally use pre-integrated. _Rails Kitchen Sink_ currently combines :

* "Devise":http://github.com/plataformatec/devise authentication.
* "CanCan":http://github.com/ryanb/cancan authorization.
* "HAML":http://haml-lang.com/ Templates.
* "CoffeeScript":http://jashkenas.github.com/coffee-script/ support.
* "metric_fu":http://metric-fu.rubyforge.org/
* Full "RSpec":http://rspec.info/ test suite
* "960":http://960.gs/ CSS grid system
* "Jammit":http://documentcloud.github.com/jammit/ asset packaging
* "Formtastic":http://github.com/justinfrench/formtastic forms
* "metric_fu":http://metric-fu.rubyforge.org/ reports.
* Full "RSpec":http://rspec.info/ test suite.
* "Spork":http://github.com/timcharper/spork DRb server.
* "960":http://960.gs/ CSS grid system.
* "Jammit":http://documentcloud.github.com/jammit/ asset packaging.
* "Formtastic":http://github.com/justinfrench/formtastic forms.

h2. Testing

Expand Down Expand Up @@ -75,6 +80,76 @@ Autotest will run the test suite automatically whenever you save changes, and if

!http://recursive-design.com/images/projects/rails-kitchen-sink/autotest_growl_notification.png!

h2. Deploying To Heroku

To deploy the application to "Heroku":http://heroku.com/, simply run _heroku create_ :

{% highlight bash %}
$ heroku create
Creating evening-beach-14... done
Created http://evening-beach-14.heroku.com/ | git@heroku.com:evening-beach-14.git
Git remote heroku added
{% endhighlight %}

The _evening-beach-14_ part will vary depending on what heroku chooses for your application.

To push your newly created application to heroku, do a _git push_ :

{% highlight bash %}
$ git push heroku master
Counting objects: 1669, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (629/629), done.
Writing objects: 100% (1669/1669), 382.36 KiB, done.
Total 1669 (delta 955), reused 1657 (delta 949)

-----> Heroku receiving push
-----> Rails app detected
-----> Gemfile detected, running Bundler version 1.0.0
Unresolved dependencies detected; Installing...
Fetching source index for http://rubygems.org/

...
[installing a bunch of gems]
...

Your bundle is complete! Use `bundle show [gemname]` to see where a bundled gem is installed.

Your bundle was installed to `.bundle/gems`
Compiled slug size is 25.6MB
-----> Launching.... done
http://evening-beach-14.heroku.com deployed to Heroku

To git@heroku.com:evening-beach-14.git
* [new branch] master -> master
{% endhighlight %}

Next, create the database on Heroku :

{% highlight bash %}
$ heroku rake db:setup
{% endhighlight %}

You should also install the free "SendGrid":http://sendgrid.com/ add-on for email delivery :

{% highlight bash %}
$ heroku addons:add sendgrid:free
{% endhighlight %}

Whenever you push changes to git, you can update heroku by doing _git push heroku_ again.

h2. Git hooks

h2. Internationalization

_Rails Kitchen Sink_ is fully I18N-ready, but unfortunately the only translation is currently (i assume fairly badly, being unable to read it) auto-generated-french from Google translate. If you'd like to contribute a translation, you can start by looking at the "translation files":http://recursive-design.com/code/p/rails-kitchen-sink/source/tree/master/config/locales and "static pages":http://recursive-design.com/code/p/rails-kitchen-sink/source/tree/master/app/views/pages. There's not a great deal of text to translate, so if anyone is feeling particularly generous and/or bored, additional translations would be very much appreciated!

h2. Stylesheets

h2. Javascript

h2. Asset Packaging

h2. Bug Reports

If you come across any problems, please "create a ticket":http://recursive-design.com/code/p/rails-kitchen-sink/issues/ and we'll try to get it fixed as soon as possible.
6 changes: 6 additions & 0 deletions app/stylesheets/pages/about.sass
Expand Up @@ -15,6 +15,12 @@ body#pages_about

p
font-style: italic

ul
margin: 0

li
font-style: italic

a.read_more
display: block
Expand Down
105 changes: 0 additions & 105 deletions app/views/pages/about.de.html.haml

This file was deleted.

25 changes: 25 additions & 0 deletions app/views/pages/about.en.html.haml
Expand Up @@ -103,3 +103,28 @@
%a{:href => 'http://github.com/justinfrench/formtastic', :class => 'read_more'} Read more...

.clear

.item
%h2
Devise
%p
Devise is a flexible authentication solution for Rails based on Warden. It:
%ul
%li
Is Rack based;
%li
Is a complete MVC solution based on Rails engines;
%li
Allows you to have multiple roles (or models/scopes) signed in at the same time;
%li
Is based on a modularity concept: use just what you really need.
%a{:href => 'http://github.com/plataformatec/devise', :class => 'read_more'} Read more...

.item
%h2
CanCan
%p
CanCan is an authorization library for Ruby on Rails which restricts what resources a given user is allowed to access. All permissions are defined in a single location (the Ability class) and not duplicated across controllers, views, and database queries.
%a{:href => 'http://github.com/ryanb/cancan', :class => 'read_more'} Read more...

.clear
105 changes: 0 additions & 105 deletions app/views/pages/about.ja.html.haml

This file was deleted.

0 comments on commit f7448d8

Please sign in to comment.