# Prado PHP Framework

PRADO is a component-based and event-driven programming framework for developing Web applications in PHP 5.
PRADO stands for PHP Rapid Application Development Object-oriented.

[![Build Status](https://travis-ci.org/pradosoft/prado.png?branch=master)](https://travis-ci.org/pradosoft/prado)
[![Coverage Status](https://coveralls.io/repos/pradosoft/prado/badge.png?branch=master)](https://coveralls.io/r/pradosoft/prado?branch=master)
[![Total Downloads](https://poser.pugx.org/pradosoft/prado/downloads.png)](https://packagist.org/packages/pradosoft/prado)
[![Latest Stable Version](https://poser.pugx.org/pradosoft/prado/v/stable.png)](https://packagist.org/packages/pradosoft/prado)

[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/pradosoft/prado?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## API Documentation
The complete API documentation can be found at http://pradosoft.github.io/docs/manual/

## Install

The best way to install Prado is [through composer](http://getcomposer.org).

Just create a composer.json file for your project:

```JSON
{
    "require": {
        "pradosoft/prado": "~3.3"
    }
}
```

Then you can run these two commands to install it:

    $ curl -s http://getcomposer.org/installer | php
    $ php composer.phar install

or simply run `composer install` if you have have already [installed the composer globally](http://getcomposer.org/doc/00-intro.md#globally).

Then you can include the autoloader, and you will have access to the library classes:

```php
<?php
require 'vendor/autoload.php';
```
## Demo Apps
The Demos folder has several different example prado applications. You can see more information about these applications here: http://www.pradoframework.net/site/demos/ . When you create your own prado application you do NOT need these folders.

* address-book
* blog
* blog-tutorial
* chat
* composer
* currency-converter
* helloworld
* northwind-db
* personal
* quickstart
* site
* soap
* sqlmap
* time-tracker


## Testing

Prado uses phpunit (https://phpunit.de/) for testing, phing (http://www.phing.info/) for building, and Selenum (http://www.seleniumhq.org/) for web browser emulation.

Running `phing` with no arguments will show you the different tests/builds that are setup in build.xml.

```
$phing
Buildfile: /yourcodepath/build.xml

prado > help:

     [echo] 

    Welcome to use PRADO build script!
    ----------------------------------
    You may use the following command format to build a target:

              phing   <target name>

    where <target name> can be one of the following:

    For all PRADO developers:
    - test           : run unit tests (results are under /build/test-reports)
    - coverage       : run unit tests collecting coverage informations
    - functionaltest : run funcitonal tests (requires Selenium Server)
    - lint           : run lint on framework
    - lint-demos     : run lint on demos
```


## Contributing

In the spirit of free software, **everyone** is encouraged to help improve this project.

Here are some ways *you* can contribute:

* by using prerelease versions
* by reporting bugs
* by writing specifications
* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by resolving issues
* by reviewing patches

Starting point:

* Fork the repo
* Clone your repo
* Make your changes
* Write tests for your changes to ensure that later changes to prado won't break your code.
* Submit your pull request