Difference between revisions of "Home"
From Joomla! Documentation
m (saving to preserve) |
m (Fixed Joomla package name) |
||
| (14 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <div class="floatright panel"><markdown> | |
| − | <div | ||
| − | |||
[](https://travis-ci.org/joomla/joomla-framework) | [](https://travis-ci.org/joomla/joomla-framework) | ||
| − | </markdown></div> | + | </markdown><small><center>Build Status</center></small></div> |
| − | + | 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. | |
| − | + | 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 [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- | ||
== Requirements == | == Requirements == | ||
| Line 27: | Line 23: | ||
<pre class="json">{ | <pre class="json">{ | ||
"require": { | "require": { | ||
| − | "joomla/ | + | "joomla/framework": "dev-master" |
} | } | ||
}</pre> | }</pre> | ||
* Download Composer | * Download Composer | ||
| − | <code>curl -sS https://getcomposer.org/installer | php</code> | + | <code>curl -sS <nowiki>https://getcomposer.org/installer</nowiki> | php</code> |
* Install the Joomla Framework | * Install the Joomla Framework | ||
| Line 40: | Line 36: | ||
=== Via Git === | === Via Git === | ||
| − | <code>git clone git://github.com/joomla/joomla-framework.git</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 | + | 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 [ | + | 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 | ||
| − | + | ||
[[Category:Joomla! Framework]] | [[Category:Joomla! Framework]] | ||
Revision as of 16:05, 1 March 2014
[](https://travis-ci.org/joomla/joomla-framework)
</markdown>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.
Requirements[edit]
- PHP 5.3.10
Installation[edit]
Via Composer[edit]
- Create a project and add a
composer.jsonfile 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[edit]
git clone git://github.com/joomla/joomla-framework.git
Getting Started[edit]
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[edit]
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[edit]
Bugs and issues found in the Joomla Framework code can be reported on the Issues list.
Contributing[edit]
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