Skip to content

Latest commit

 

History

History
117 lines (81 loc) · 4.29 KB

README.md

File metadata and controls

117 lines (81 loc) · 4.29 KB
Raw

Application Skeleton for PHP-Flange 👊

This is a skeleton application for creating applications using PHP-Flange. It is pre-configured, clean and easy to use. If you interested, you might check out our demo applications:

🔰 Introduction

This project is structured using Separation of Concerns principle, instead of strictly following MVC design pattern. Which provides modern and rapid development, with the flexibility to customized and use with any php library out there.

🔥 Features

  • Flexible URI routing.
  • Code reusable and easier to maintain.
  • High-performance Lightweight PHP framework
  • Perfect Container management, Dependency Injection (DI)
  • PSR-{2,3,4,6,7,11,15,16,17} compliant
  • Integration with external libraries
  • Shipped with Tracy exceptions handler and debugger
  • Flexible configuration's setup, highly scalable
  • Supports hybrid runtime: RoadRunner, ReactPHP, AmPHP, or Swoole
  • And MORE ...

📦 Getting Started & Installation

For getting started with this project or contributing, you have to follow the below procedure. First navigate to a main directory. Then run below command on terminal for getting started.

git clone https://github.com/biurad/php-framework.git flange
cd flange

OR

composer create-project biurad/framework my_project

Once installed, you can test it out immediately using PHP's built-in web server:

$ php flange serve
# OR use php command
$ php -S 127.0.0.1:8000 -t public
# OR use the composer alias:
$ composer run --timeout 0 serve

To update the project directory's structure to the latest version, run the following command:

php rade self-update

📓 Documentation

For in-depth documentation before using this library. Full documentation on advanced usage, configuration, and customization can be found at docs.biurad.com.

⏫ Upgrading

Information on how to upgrade to newer versions of this library can be found in the UPGRADE.

🏷️ Changelog

SemVer is followed closely. Minor and patch releases should not introduce breaking changes to the codebase; See CHANGELOG for more information on what has changed recently.

👷‍♀️ Contributing

To report a security vulnerability, please use the Biurad Security. We will coordinate the fix and eventually commit the solution in this project.

Contributions to this library are welcome, please see CONTRIBUTING for additional details.

🧪 Testing

To run the tests you'll have to start the included node based server first if any in a separate terminal window.

With the server running, you can start testing.

composer test

👥 Credits & Acknowledgements

🙌 Sponsors

Are you interested in sponsoring development of this project? Reach out and support us on Patreon or see https://biurad.com/sponsor for a list of ways to contribute.

📄 License

biurad/php-framework is licensed under the BSD-3 license. See the LICENSE file for more details.