Joomla! Documentation™

<sidebar>

• Joomla!
  • http://www.joomla.org | Main
  • http://community.joomla.org | Community
  • http://forum.joomla.org | Forum
  • http://extensions.joomla.org | Extensions
  • http://shop.joomla.org | Shop
  • http://developer.joomla.org | Developers
  • http://api.joomla.org | API

• Joomla! Framework
  • Framework:Home|Framework Home
  • Framework:About|About
  • Framework:Resources|Resources
  • Main_Page|Docs Home Page

</sidebar>

<markdown>

[](https://travis-ci.org/joomla/joomla-framework)

</markdown>

What is the Joomla Framework ?

The Joomla Framework is a platform for writing web and command line applications in PHP. It is free and open source software, distributed under the GNU General Public License version 2 or later.

It is comprises code originally developed for the Joomla Content Management System (CMS). For more information about the Joomla CMS visit http://www.joomla.org/about-joomla.html.

For news and information about developering with Joomla, please visit http://developer.joomla.org.

View the Joomla Framework API Documentation at http://joomla.github.com/joomla-framework. Powered by phpDocumentor 2.

You can discuss Joomla Framework development by joining the mailing list at http://groups.google.com/group/joomla-dev-platform.

Requirements

• PHP 5.3.10

Installation

Via Composer

• Create a project and add a composer.json file to it with the content :

{
    "require": {
        "joomla/joomla-framework": "dev-master"
    }
}

• Download Composer

curl -sS https://getcomposer.org/installer | php

• Install the Joomla Framework

php composer.phar install

Via Git

git clone git://github.com/joomla/joomla-framework.git

Documentation

General documentation about the Joomla Platform can be found under the /docs folder of the Git repository. In addition, each package has documentation in a README.md file.

Reporting Bugs and Issue

Bugs and issues found in the Joomla Framework code can be reported on the Issues list.

Contributing

All kind of contributions are welcome. Please read about how to contribute here.

You may find tasks you can do on the Issues list by filtering on labels and milestones