README

About ApPHP Framework

Thank you for choosing ApPHP - a high-performance PHP MVC framework.

ApPHP MVC Framework is designed to provide modern and rapid development of websites, web applications and web services.

It implements the the Model-View-Controller (MVC) design pattern and principles, including separation of display, logic, and data layers. It provides an architecture, components and tools for developers to build a complex web applications faster and safer.

Installing ApPHP Framework

via Git

git clone https://github.com/apphp/php-mvc-framework.git

via Composer

You can install ApPHP into your project using Composer.

If you're starting a new project, we recommend using the Directy CMF as a starting point. For installing new version in existing applications you can run the following:

composer require apphp/php-mvc-framework

Manual installation

Please make sure the release file is unpacked under a web-accessible directory. You will see the following files and directories:

demos/              demo applications
docs/               documentation
framework/          framework source files
tests/              PHPUnit tests
utils/              some utilities
    requirements/   requirements checker
    tests/          tests
    generators/     code generators
CHANGELOG           describing changes in every ApPHP release
LICENSE             license of ApPHP Framework
README              this file
UPDATE              updating instructions

Running Tests

Assuming you have PHPUnit installed system wide using one of the methods stated here, you can run the tests for ApPHP Framework by doing the following:

Install composer on your server.
After Composer is installed, install PHPUnit by

composer require phpunit/phpunit --dev

Make sure you added following to composer.json file:

"scripts": {
    "tests-result": "phpunit --colors=always --log-junit test-results.xml",
    "tests": "phpunit --colors=always",
    "test": "phpunit --colors=always --filter"
}

Run phpunit by:

composer tests

Requirements

The minimum requirement by ApPHP is that your Web server supports PHP 5.4.0 or above. ApPHP has been tested with Apache HTTP server on Windows and Linux operating systems.

License

The Laravel framework is open-sourced software licensed under the LGPL3 license.

What's next

Please visit the project website for tutorials, class reference and join discussions with other ApPHP users.

apphp / php-mvc-framework

Maintainers

Details