Actions

Framework

Difference between revisions of "Home"

From Joomla! Documentation

m (update)
m (Fixed Joomla package name)
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{:{{FULLPAGENAME}}/header}}__NOTOC__
+
<div class="floatright panel"><markdown>
<div style="width:auto; vertical-align:top; background-color:#fff; margin:5px 0 10px 0; padding:8px;  box-shadow: 1px 1px 8px #000;">
+
<div style="float:right; padding-left:15px;"><markdown>
+
 
[![Build Status](https://travis-ci.org/joomla/joomla-framework.png?branch=master)](https://travis-ci.org/joomla/joomla-framework)
 
[![Build Status](https://travis-ci.org/joomla/joomla-framework.png?branch=master)](https://travis-ci.org/joomla/joomla-framework)
</markdown></div>
+
</markdown><small><center>Build Status</center></small></div>
== What is the Joomla Framework ? ==
+
The <code>Joomla! Framework</code> 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.
  
The <code>Joomla Framework</code> 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 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.
  
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 developing with Joomla, please visit http://developer.joomla.org.
  
For news and information about developering with Joomla, please visit http://developer.joomla.org.
+
View the Joomla Framework API Documentation at http://api.joomla.org and is powered by [http://www.phpdoc.org phpDocumentor 2].
  
View the Joomla Framework API Documentation at http://joomla.github.com/joomla-framework. Powered by [http://www.phpdoc.org phpDocumentor 2].
+
You can discuss Joomla Framework development by joining the mailing list at http://groups.google.com/group/joomla-dev-framework.
 
+
You can discuss Joomla Framework development by joining the mailing list at http://groups.google.com/group/joomla-dev-platform.
+
  
 
== Requirements ==
 
== Requirements ==
Line 27: Line 23:
 
<pre class="json">{
 
<pre class="json">{
 
     "require": {
 
     "require": {
         "joomla/joomla-framework": "dev-master"
+
         "joomla/framework": "dev-master"
 
     }
 
     }
 
}</pre>
 
}</pre>
Line 41: Line 37:
  
 
<code><nowiki>git clone git://github.com/joomla/joomla-framework.git</nowiki></code>
 
<code><nowiki>git clone git://github.com/joomla/joomla-framework.git</nowiki></code>
 +
 +
== Getting Started ==
 +
 +
The [[Framework:Getting_Started|Framework Getting Started]] page has some questions and answers to some common problems that may occur getting started with your first app.  Another great resource is the sample framework app.  You can find this on github here.  https://github.com/dbhurley/framework-app
  
 
== Documentation ==
 
== Documentation ==
  
General documentation about the Joomla Platform can be found under the [https://github.com/joomla/joomla-framework/tree/master/docs /docs] folder of the Git repository. In addition, each package has documentation in a <code>README.md</code> file.
+
General documentation about the Joomla Framework can be found under the [https://github.com/joomla/joomla-framework/tree/master/docs /docs] folder of the Git repository. In addition, each package has documentation in a <code>README.md</code> file.
  
 
== Reporting Bugs and Issue ==
 
== Reporting Bugs and Issue ==
Line 52: Line 52:
 
== Contributing ==
 
== Contributing ==
  
All kind of contributions are welcome. Please read about how to contribute [[CONTRIBUTING.markdown|here]].
+
All kind of contributions are welcome. Please read about how to contribute [https://github.com/joomla/joomla-framework/blob/master/CONTRIBUTING.markdown here].
  
 
You may find tasks you can do on the [https://github.com/joomla/joomla-framework/issues Issues] list by filtering on labels and milestones
 
You may find tasks you can do on the [https://github.com/joomla/joomla-framework/issues Issues] list by filtering on labels and milestones
</div>
+
 
 
[[Category:Joomla! Framework]]
 
[[Category:Joomla! Framework]]

Latest revision as of 15:05, 1 March 2014

Build Status

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 and 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.

Contents

Requirements

  • PHP 5.3.10

Installation

Via Composer

  • Create a project and add a composer.json file to it with the 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 getting started with your first app. Another great resource is the sample framework app. You can find this 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