Joomla! Documentation™

https://api.travis-ci.org/joomla/joomla-framework.png

Build Status

The Joomla! Framework is a framework 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 composed of 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 developing with Joomla, please visit http://developer.joomla.org.

View the Joomla Framework API Documentation at http://api.joomla.org, which is powered by phpDocumentor 2.

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

Requirements

• PHP 5.3.10

Installation

Via Composer

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

{
    "require": {
        "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

Getting Started

The Framework Getting Started page has some questions and answers to some common problems that may occur while getting started with your first app. Another great resource is the sample framework app. You can find it on github here. https://github.com/dbhurley/framework-app

Documentation

General documentation about the Joomla Framework 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