OsFinancials Webtop Developer Guide

Ok, just started this page to see if we can create a development community to start a Webtop version of osFinancials.

I have investigated some development environments for webbased applications and came to the conclusion that Ruby on Rails does meet al(most) every need. It works with Firebird database so we can use the current osFinancials dataset. Has transaction management, AJAX functionality, is "RAD" compliant, and many more.

We can start with some small functionality like e.g. a POS system and build from here further to extend functionality. It is up to you. We will use the current osFinancials dataset so user can use the Desktop aswel as the Webtop version on the same dataset.

Let us discus on the discussion page how we will proceed.

Welcome to osFinancials Webtop development.

osFinancials Webtop uses the framework "Ruby on Rails" and the Aptana IDE (formerly RadRails). These run on Linux, Mac and Windows machines. You may start downloading AptanaIDE from http://www.aptana.org/download_rails_rdt.php Follow the install instructions on their site and you'll get a full Rails developmentenvironment ready to roll. Alternatively, since Rails is entirely interpreted with no precompilation and all code distributed in source form, you may prefer TextMate, e-editor, Emacs or Vim - but be aware that many of the core team will be using Aptana.

After installing the IDE, you'll need to install the Firebird database driver into Rails from the command prompt of your system with "gem install fireruby" (gem is a command installed by default on most systems when you install Ruby).

You also need the firebird database version 2.x installed somewhere in you network or on your local machine. Get it from http://www.firebirdsql.org Note: Firebird is included in the osFInancials Desktop version installer!

You can now connect with your installed AptanaIDE to the osFInancials subversion server to checkout the latest source in your Workspace. Push "Alt+Shift+N to start a new project and choose "Other" from the list on the bottom. A new window opens and choose "SVN" from there. Choose Create a new repository location" and fill as location https://osfinancials.svn.sourceforge.net/svnroot/osfinancials/osF_Webtop/trunk Follow the guide till it is finished and your osFinancials project is imported.

Now you have to copy/configure some files (not rename!!!), only a few and you are up and running; These are: copy /config/database.yml.example to /config/database.yml copy /public/dispatch.cgi.example to /public/dispatch.cgi copy /public/dispatch.fcgi.example to /public/dispatch.fcgi copy /public/dispatch.rb.example to /public/dispatch.rb

Edit the files to your needs, mostly the database.yml that contains your specific database settings, only will be sufficient.

Then create 3 databases in your Firebird as mentioned in database.yml . Add these 3 databases also to your Firebirds aliasses.conf file so Firebird knows the full pad to your databases.

You should be up and running.

SVN - HINT This project SVN is configured to avoid uploading the following files that could contain user specific information; /config/database.yml /public/dispatch.* /log/* /tmp/*