Assembla home | Assembla project page
 

Setup Development Environment

Install the Tools

Install ruby, gem, and rails

Version:

  • We are currently using Rails version 2.0.2 (see line 8 of this source code ) with ruby 1.8.6

All Operating Systems

Windows

  • Download and install the Ruby Windows Installer and then type "gem install rails --include-dependencies" in cmd.exe prompt
  • Go into your editor preferences and set your line endings to UNIX. This is important. Send me a message if you are not sure how to do this with your editor.

Install Libraries

Any libraries that you need to load with GEM will be listed here. All can be retrieved with "gem install <package>". 

gem install RedCloth BlueCloth mime-types json xml-simple captcha tzinfo --include-dependencies

In the latest version fo the system, the Rmagick gem is required. It is used to generate thumbnails and captcha images. It relies on the Imagemagick library. On windows you will need to download the gem, unzip it, and follow the instructions in the README file to install Imagemagick and Rmagick.

If you want to enable Captcha, install Captcha

Install a database server if you do not already have one

  • MySQL 5.X : http://dev.mysql.com/downloads/ and rails instructions . Do not use versions of MySQL lower than 4.1. Note: MySQL 5 is required if you want to run text search.
  • Postgres:This system will also work with Postgres, although we have not tested it thoroughly. If you do install it with Postgres, please report any bugs and we will fix them.

Install the Rails IDE

Netbeans with ruby support

Download IDE from here

Aptana IDE aka RadRails?

Optional: Read this linked Easy Setup page for instructions about how to set up a development environment with Radrails. This will be useful to you if you are a graphic designer with limited programming experience. It also describes how to check out a project from Subversion into Radrails / Eclipse, which is something that is hard to figure out.

Install a Subversion client

(Other client not needed if you use the Radrails IDE.)

Get the Code

Checkout from the Subversion URL at http://tools.assembla.com/svn/breakout/breakout

You will need to log in with any Assembla.com username and password. Assembla.com is an instance of Breakout. You can register here.

If you use Radrails (with its embedded Subclipse) follow these svn checkout instructions

If you use Windows InstantRails?, checkout the code into \InstantRails?\rails_apps\breakout. After the initial build of breakout, it will be available within InstantRails? -> Menu -> Rails Applications -> Managing Rails Applications.

Run the initial build

In order to avoid overwriting your configuration files, we have renamed the configuration files that you are likely to modify to ".example". Please copy these files and edit the new versions to match your environment.

  • config/database.yml.example -> config/database.yml
  • config/environments/local_conf-example.rb -> local_conf.rb . In this system, user_environment.rb holds default settings, and it calls local_conf.rb to get any local configurations that you want to change. If you do not have a mail server installed on your computer, you must edit the ActionMailer parameters in this file so that the application can connect to your SMTP email account and send email. This will be required to confirm your registration as a test user. Assembla can provide email accounts if necessary.
  • juggernaut_config.yml.example -> config/juggernaut_config.yml . This is used only by the chat tool. You do not need to edit this file if you do not want to run the chat server and chat tool.

Set up the database

  • Create a database "breakout_development"
  • Configure config/database.yml to connect to database breakout_development

We update this database using Rails Migrations. Go to a console prompt in your breakout directory and run the Migrations with 

rake db:migrate

If you start a Webbrick server for the rails application you just checked out and configured, you should be able to get the application root in a browser, usually on URL http://localhost:3000 . This will display the home page.

Submit your enhancements

We will copy the procedure for submitting Rails contributions. Create a diff with your changes: svn diff > my_properly_named_patch.diff . Then create a new ticket with [PATCH] as the first word in the summary and upload (not paste) your diff.

To get a feeling about the code and the processes, please use StartDevelopmentExample?

Other Information

For Chat Tool setup, please go here -> SetupChat

Subscribe to the Timeline RSS Feed and use your blog reader to manage the messages.

Post questions here with severity=question.

AndySingleton -- Team leader contact information

Setup Problems

If you have problems, please review the document SetupProblems?

Captcha Configuration

If you have problems configuring captcha, please review the wiki:0.6-ReleaseConfiguration

Attachments