Project

General

Profile

Edit History

Setting up a Development Environment » History » Version 1

Rick Glunt, 02/08/2010 09:35 AM

1 1 Rick Glunt 
h1. Setting up a Development Environment
2 





    3
    
    
    
h2. Introduction





    4
    
    
    





    5
    
    
    
If you start developing for the project or just with VirtueMart you may have already set up a development environment with an IDE and a SVN program. 





    6
    
    
    





    7
    
    
    
If you haven't done so or if you want to know what to do better, you can follow the instructions given on this page. 





    8
    
    
    





    9
    
    
    
The following programs are recommended for working with VirtueMart and synchronizing the working directory with the local SVN repository: 





    10
    
    
    





    11
    
    
    
•SmartSVN (a very easy, but professional platform-independent SVN program) 





    12
    
    
    
•Total Commander (perfect for sync'ing the contents of two directories) 





    13
    
    
    
•Ant (for building installable packages) 





    14
    
    
    
•Zend Studio (the state of the art when it comes to a PHP IDE, costs!) 





    15
    
    
    
•or PHP Development Tools for Eclipse (very good PHP IDE and free!) 





    16
    
    
    





    17
    
    
    
Of course there are other programs that can do the same as the ones mentioned above, but remember: these are just recommendations. 





    18
    
    
    





    19
    
    
    
h2. Setup an IDE and SVN





    20
    
    
    





    21
    
    
    
If you want to join the project it is important that you have a similar environment like the other devs, so it makes it easier for everyone to help each other. 





    22
    
    
    





    23
    
    
    
First setup up an IDE, I suggest you follow the explanations here: http://docs.joomla.org/Setting_up_your_workstation_for_Joomla!_development 





    24
    
    
    





    25
    
    
    
After that download the installer of virtuemart and install it in joomla. AFTER that configure the SVN. 





    26
    
    
    





    27
    
    
    
The SVN folder structure is setup with 3 root folders; trunk, tags and branches. The trunk folder is used for curent active development. The tags folder is used for public releases. The branches folder can be used for code branches. 





    28
    
    
    





    29
    
    
    
The structure found under these root folders mimic the structure in a typical Joomla installation, however, only contain the VirtueMart code. This gives us the ability to easily commit and checkout directly from a Joomla installation as described above. 





    30
    
    
    





    31
    
    
    
There are 3 different folders for backend, frontend and modules 





    32
    
    
    





    33
    
    
    
•trunk/administrator/components/com_virtuemart 





    34
    
    
    
•trunk/components/com_virtuemart 





    35
    
    
    
•trunk/modules/(..not ready, we are pleased if you want to write a module) 





    36
    
    
    





    37
    
    
    
The /trunk is your joomla base root = jRoot. 





    38
    
    
    





    39
    
    
    
At best is if you have a joomla installation and make 1 checkout for back and frontend. Before you can checkout the svn you should delete the files that are installed by the vm installer. Just delete this directories 





    40
    
    
    





    41
    
    
    
•administrator/components/com_virtuemart 





    42
    
    
    
•components/com_virtuemart 





    43
    
    
    
and the language files named en-GB.com_virtuemart.ini in 





    44
    
    
    
•administrator\language 





    45
    
    
    
•language 





    46
    
    
    





    47
    
    
    
use for checkout on the joomla base root: 





    48
    
    
    





    49
    
    
    
svn co https://dev.virtuemart.net/svn/virtuemart/trunk/virtuemart 





    50
    
    
    





    51
    
    
    
After updating you should have the newest version of VirtueMart 





    52
    
    
    





    53
    
    
    
If you want to check the mails you may want to use hamster as mailserver