From Katrina Help Info

Table of contents

1 Developer Guidelines 1.1 Windows Notes 1.2 Ruby Notes 1.3 Subversion Notes

Developer Guidelines

This page summarizes the technical guidelines we currently follow in our projects. All of our software is open-source. The new code we create is primarily Ruby (http://www.ruby-lang.org/en/), with occasional snippets of other languages thrown in. We use the Rails (http://www.rubyonrails.com/) MVC application framework for our web application development. We use MySQL (http://dev.mysql.com/) for our backend database.

Windows Notes

• Rolling with Rails (http://www.onlamp.com/pub/a/onlamp/2005/01/20/rails.html) (Windows Installation tutorial)
• Ruby 1.8.2 pathlevel 15 One Click Installer for Windows with RubyGems included already (http://rubyforge.org/frs/download.php/4174/ruby182-15.exe)
• MySQL for Windows download (http://dev.mysql.com/get/Downloads/MySQL-4.1/mysql-essential-4.1.14-win32.msi/from/pick#mirrors)

• FreeRIDE Ruby Integrated Development Environment version 0.9.4 (http://rubyforge.org/frs/download.php/3929/freeride-win-installer-0.9.4.exe)
  • FreeRIDE Project Wiki (http://freeride.rubyforge.org/wiki/wiki.pl)
• One-click installer for 'cream' derivative of Vim text editor version 6-30-90 (http://cream.sourceforge.net/gvim-6-3-90.exe)
  • The Official VIM Editor site (http://www.vim.org/) | VIM on Sourceforge (http://vim.sourceforge.net/)
  • The Vim commands cheat sheet (http://www.tuxfiles.org/linuxhelp/vimcheat.html)
• RadRails (http://www.radrails.org/) This is a full fledge IDE for Ruby On Rails. It is built on the powerful eclipse platform (http://www.eclipse.org). It has builtin support for SVN and CVS. RadRails is a Java desktop application that runs on Windows, Mac OS X, and Linux. Requires Ruby on Rails to be installed.

Ruby Notes

• Buy Agile Web Development with Rails

• Buy Programming Ruby (http://www.rubycentral.com/book/) or read online using the link for free

• RubyForge (http://rubyforge.org/) - a home for open source Ruby projects

• RubyGarden Wiki (http://rubygarden.org/ruby)

Subversion Notes

• svn stands for subversion. svn is also the command you use at the shell.
• You can read about Subversion here (http://svnbook.red-bean.com/en/1.1/svn-book.html)
• TortoiseSVN is a popular GUI SVN client for Windows (http://tortoisesvn.tigris.org/)
• To use svn+ssh mode in TortoiseSVN you should follow this guide (http://www.logemann.org/day/archives/000099.html)

Rudi has gotten this working under Windows 2000.

• You need to sign up for a developer account at BerliOS Developer Portal (http://developer.berlios.de/) and then tell Rudi (cilibrar AT gmail.com) your username on BerliOS so that you can be added to the developer list.
• You will also want to check out the current source code using the svn+ssh version of the repository identifier as documented on BerliOS aidwatch project (http://developer.berlios.de/svn/?group_id=2900)
• After checkout, start making changes to the source code. To test your changes the simplest option is often just to run ./script/server in the rails directory. You may need to install MySQL as well.
• To send your changes to the rest of the team do an svn commit
• Sometimes you need to do an svn update in order to get other people's changes to the repository. This may be necessary before you can commit.
• Very rarely you may edit the same file as somebody else at the same time in the same place, usually by accident. This can cause conflicts which should be resolved using the svn resolved command (http://svnbook.red-bean.com/en/1.1/re24.html) if you get stuck by a conflict message and cannot commit.