Getting started
Quickstart Screencast
Quickstart Guide
Quickstart for Heroku Apps
Setting up your Project

Resources & Demos
Demo App for Rails 3.x
See how to do a complete implementation of i18n (internationalization) and l10n (localization) using Wordchuck.
Demo App Source Code
Source code showing a complete implementation of i18n (internationalization) and l10n (localization).

Support
Report an Issue
Request a Feature

Wordchuck Quickstart Guide

Get started by watching our screencast:



We've coded and documented a full internationalizaton (i18n) implementation, so take a look and use it as a reference.

See the app & documentation
Get the source code on github

Step 1: Set up your Wordchuck project


Go to http://wordchuck.com/signup to create your account.

See detailed project setup instructions here, or watch the first half of the screencast above.

Step 2: Internationalize (i18n)

If your app is not already internationalized, we recommend you get started by adding your app's content to your Wordchuck project.

As you add content, Wordchuck will generate the proper i18n code to insert into your app. This way, there's no guessing about what needs to go where. [see example]

If this is your first time internationalizing an app, our Demo App is a step-by-step guide showing how to do a complete i18n implementation in Rails. You can see all of the source code for the Demo App at github.

Step 3: Install the Wordchuck Ruby Gem

Install the Wordchuck gem:

$ sudo gem install wordchuck

Create an initializer (config/initializers/wordchuck.rb) to store your project's API key:

Wordchuck.configure do |config|
  config.project_key = 'whatever_your_project_key_is'
end


Your project's API key can be found on the "settings" page in the Wordchuck App.

FOR RAILS 3.x:

Add the gem to your Gemfile like so:

gem 'wordchuck'

FOR RAILS 2.x:

Add the gem to config/environments.rb like so:

config.gem 'wordchuck'

You'll also need to add the Rake task (generate.rake) to your lib/tasks folder. It can be found here.

If you don't have a locales folder in your config directory, create it. We know, we're working on it :)


Step 4: Generate your locale files

The Wordchuck gem automatically generates your locale files, including all of the latest translations for each language. To generate locale files, run the following rake task:

$ rake wordchuck:generate

Locale files are generated in the config/locales directory.

You can generate your locale files as often as you like. Each time you run the rake task, the old locale files are REPLACED with the new ones. It is important that you don't modify the locale files directly, as any manual changes will be overwritten next time the rake task is run.