Actions

Difference between revisions of "Setting up your workstation for Joomla! development"

From Joomla! Documentation

m (merge, two article same name only missing ! in Joomla!)
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{underconstruction}}
+
{{merge|Setting up your workstation for Joomla development|date=15 Sep 2013}}
 +
This article provides detailed instructions for setting up your workstation for Joomla! development with Apache, PHP, xdebug, Git. Please refer to the following links for other development tools and environments: [[Setting up your workstation for Joomla development]]
  
{{RightTOC}}
+
The article more specifically let's you contribute to the official Joomla! Github code repository.
 
+
== Introduction ==
+
This article provides detailed instructions for setting up your workstation for Joomla! development. Note that there are many possible configurations for doing Joomla! development. Any environment that supports Apache, MySql, PHP, and Subversion should work for writing Joomla! code and extensions.
+
 
+
This document provides step-by-step instructions for setting up and working with Apache, PHP, xdebug, Subversion. This instruction uses Eclipse IDE from chapter 4 and onwards. Please refer to the following links for other development tools:
+
 
+
* [[Setting up your workstation for joomla development]]
+
 
+
The example used and screenshots are for Windows XP, but the basic steps are the same for Linux.
+
  
 
== Install & configure XAMPP, php, Eclipse ==
 
== Install & configure XAMPP, php, Eclipse ==
[[Configuring a XAMPP server for joomla development]]
+
# [[Configuring a XAMPP server for joomla development]]
[[Edit PHP.INI File]]
+
# [[Edit PHP.INI File for XDebug]]
[[Configuring Eclipse for joomla development]]
+
# [[Configuring Eclipse for joomla development]]
 
+
== Install Eclipse Subversion ==
+
Before we can start coding in Joomla!, we need to be able to work with the Subversion (SVN) source code repository. Subversion is a third-party plugin for Eclipse, so we need to use the Eclipse Update Manager to install it. To do this, navigate to Help / Software Updates, as shown below.
+
 
+
[[Image:Eclipse_help_software_updates.png]]
+
 
+
The Software Updates and Add-ons dialog will display. Select the "Available Software" tab. The list of available update sites will display. Press the "Add Site" button to display the Add Site dialog. Enter "http://subclipse.tigris.org/update_1.8.x" as the URL, as shown below.
+
'''NOTE: 1.8 is the current version as of the date of this update: July 20, 2012'''
+
 
+
[[Image:Subclipse_update_site_1.6.png]]
+
 
+
Press OK and the "Available Software" tab should again display, this time with additional options from the Subclipse site. Select all Subclipse options as shown below. Then press the "Install" button.
+
+
[[Image:Eclipse_install_update_1.6.png]]
+
 
+
Eclipse will work for a minute and then display the Install window, shown below. Press the "Next" button. A "Review Licenses" window appears. Click "I accept the terms of the license agreements". Now click finish.
+
 
+
[[Image:Eclipse_install_update2_1.6.png]]
+
 
+
After the files have been downloaded and installed, Eclipse will show the message below recommending that you restart Eclipse. Press "Yes" and Eclipse will restart.
+
 
+
[[Image:Eclipse_install_update3.png]]
+
 
+
Once Eclipse has restarted, we can test that the Subversion plugin is working. Select File / Import as shown below.
+
  
[[Image:File_import.png]]
+
== Check Out and modify Joomla! Source Code ==
 +
Now we are going to create a new PHP project that will contain all of the source code files for Joomla!. We can import the source code and create our PHP project at the same time.
  
Then expand the SVN element in the tree. You should see an option called "Checkout Projects from SVN", as shown below.
+
To do so, please see [[Working with git and github/My first pull request]]
  
[[Image:Svn_checkout_projects.png]]
+
== Working With Git and Github ==
 +
The CMS project uses the Git version control system and the CMS repository is stored on Github here: [https://github.com/joomla/joomla-cms https://github.com/joomla/joomla-cms]. Bugs are fixed in the master branch of this repository, and normally there are bug fixes and changes in the master branch that are more recent than the latest released Joomla version. For this reason, when we test and code bug fixes, we normally use the latest code from the master branch on Github, not the latest released version. Therefore, Bug Squad testers and coders need to understand how to use Git and the Github repository.
  
At this point, the plugin has been installed successfully. Press "Cancel" to cancel the import. (We'll import the Joomla! project in the next section.)
+
For testing and tracking changes, please refer to [[Git for Testers and Trackers]]. For coding changes, please see [[Git for Coders]].
  
== Setting up your workstation for Joomla! development -- Part 2 ==
+
==Extension Development==
This article is continued here: [[Setting up your workstation for Joomla! development -- Part 2]]. This includes checking out the Joomla! source code, debugging Joomla! from Eclipse, creating patch files, and Eclipse tips and tricks.
+
For Eclipse setup information related to Joomla! extension development, see [[Setting up your workstation for extension development]].
  
 
[[Category:Development]]
 
[[Category:Development]]
 
[[Category:Bug Squad]]
 
[[Category:Bug Squad]]

Latest revision as of 00:34, 15 September 2013

Merge-icon.png
Merge Notice

It has been suggested that this article or section be merged with Setting up your workstation for Joomla development. (Discuss). Proposed since 15 Sep 2013.

This article provides detailed instructions for setting up your workstation for Joomla! development with Apache, PHP, xdebug, Git. Please refer to the following links for other development tools and environments: Setting up your workstation for Joomla development

The article more specifically let's you contribute to the official Joomla! Github code repository.

Contents

Install & configure XAMPP, php, Eclipse

  1. Configuring a XAMPP server for joomla development
  2. Edit PHP.INI File for XDebug
  3. Configuring Eclipse for joomla development

Check Out and modify Joomla! Source Code

Now we are going to create a new PHP project that will contain all of the source code files for Joomla!. We can import the source code and create our PHP project at the same time.

To do so, please see Working with git and github/My first pull request

Working With Git and Github

The CMS project uses the Git version control system and the CMS repository is stored on Github here: https://github.com/joomla/joomla-cms. Bugs are fixed in the master branch of this repository, and normally there are bug fixes and changes in the master branch that are more recent than the latest released Joomla version. For this reason, when we test and code bug fixes, we normally use the latest code from the master branch on Github, not the latest released version. Therefore, Bug Squad testers and coders need to understand how to use Git and the Github repository.

For testing and tracking changes, please refer to Git for Testers and Trackers. For coding changes, please see Git for Coders.

Extension Development

For Eclipse setup information related to Joomla! extension development, see Setting up your workstation for extension development.