Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "EPF Wiki Development Guide"

m (Development Environment Setup)
m (Development Environment Setup)
Line 8: Line 8:
 
  Rails 2.0.2  
 
  Rails 2.0.2  
 
  MySQL 5.0.15 or higher
 
  MySQL 5.0.15 or higher
  [http://sourceforge.net/projects/unxutils Windows UnxUtils]  
+
  [http://sourceforge.net/projects/unxutils Windows UnxUtils] (for Windows)
 
  [http://tinymce.moxiecode.com TinyMCE]  
 
  [http://tinymce.moxiecode.com TinyMCE]  
  
You can use another database, in fact you can use any of [http://wiki.rubyonrails.org/rails/pages/DatabaseDrivers supported databases] by Rails migrations. For MySQL we recommend using XAMPP.
+
You can use another database, in fact you can use any of [http://wiki.rubyonrails.org/rails/pages/DatabaseDrivers supported databases] by Rails migrations. The current documentation of EPF Wiki is based on experiences with having the development environment on Windows (XP) and the production environment on Linux. For this reason UnxUtils is included with the requirements for the development environment.
  
3. Install Ruby Gems
+
Ruby is shipped with [http://en.wikipedia.org/wiki/SciTE SCIntilla based Text Editor] so this minimum setup is already very complete. But for more serious development work the following extra components come highly recommended.
4. Generate RoR skeleton and extract downloaded epfwiki_R$VERSION$_$BUILDID$.zip
+
 
5. Install Python & script html2text.py
+
XAMPP
6. Edit config files: add database information and SMTP server
+
Aptana Studio
7. Install EPF Wiki database schema
+
 
8. Install HTML editor: PinEdit and/or TinyMCE
+
XAMPP includes MySQL so this replaces the MySQL database listed with the minimum requirements. On top of that XAMPP includes many other usefull components for development.  
9. Install diff tool: CSDiff
+
10. path in dispatch.rb
+
11. test the configuration
+
  
 
=== Install Ruby and Ruby Gems ===
 
=== Install Ruby and Ruby Gems ===

Revision as of 03:45, 11 April 2008

Welcome to the EPF Wiki Development Guide. This guide covers the steps necessary to begin development on EPF Wiki using Aptana Studio, CVS, and Bugzilla.

Development Environment Setup

Minimum Requirements

Ruby 1.8.4
Ruby Gems 0.9.0
Rails 2.0.2 
MySQL 5.0.15 or higher
Windows UnxUtils (for Windows)
TinyMCE 

You can use another database, in fact you can use any of supported databases by Rails migrations. The current documentation of EPF Wiki is based on experiences with having the development environment on Windows (XP) and the production environment on Linux. For this reason UnxUtils is included with the requirements for the development environment.

Ruby is shipped with SCIntilla based Text Editor so this minimum setup is already very complete. But for more serious development work the following extra components come highly recommended.

XAMPP
Aptana Studio

XAMPP includes MySQL so this replaces the MySQL database listed with the minimum requirements. On top of that XAMPP includes many other usefull components for development.

Install Ruby and Ruby Gems

Install Ruby On Rails

Aptana Studio

  • Download Aptana Studio
  • Add RadRails to Aptana Studio by following the Start Page instructions (Help > Aptana Studio Start Page...).

See the screencast for more information.

Checkout project from CVS

Start Aptana Studio and switch to the CVS repository perspective. Add a repository location with the following properties

Connection type: extssh
Host: dev.eclipse.org
Repository path: /cvsroot/technology

See also CVS Repository Setup in the EPF Composer Development Guide

Create a Development and Test Database

Rails

Run Tests

Build Process

Bugzilla Setup

See EPF Composer Development Guide

References

EPF Composer Development Guide

Welcome to RadRails, the Ruby on Rails authoring environment for Aptana Studio and Eclipse

Back to the top