biurad/framework

Biurad Framework is a high performance framework with expressive, elegant syntax, and great security

v1.0.5 2020-12-06 03:44 UTC

This package is auto-updated.

Last update: 2021-12-31 00:29:23 UTC


README

This project is built with a PHP based PSR complaint framework Biurad, a high performance framework with expressive, elegant syntax, and great security which was bootstrapped using Composer.

🚀 master is automatically deployed to demo.biurad.studio: Heroku

🔰 Introduction

This project is designed with Biurad PHP framework to provide modern and rapid development to our project, focusing on Separation of Concerns, and not a strict complaint framework rule (eg: MVC). With Biurad you enjoy maximum customization, and overall flexibility with no limitations. Biurad is fast, light, secure and flexible.

🔥 Features

📦 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
cd php-framework

composer install

OR

composer create-project biurad/framework my_project

To run the app in the development mode.
Open http://localhost:8000 to view it in the browser.

composer serve

Before running composer serve, cd into your project directory then run the script

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

🛠️ Maintenance & Support

When a new major version is released (1.0, 2.0, etc), the previous one (0.19.x) will receive bug fixes for at least 3 months and security updates for 6 months after that new release comes out.

(This policy may change in the future and exceptions may be made on a case-by-case basis.)

Professional support, including notification of new releases and security updates, is available at Biurad Commits.

👷‍♀️ 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, especially ones that:

  • Improve usability or flexibility without compromising our ability to adhere to [React].
  • Optimize performance
  • Fix issues with code and backward compatability.

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.