pionia/pionia-core

PHP REST-API framework for developers with deadlines

v2.0.3 2024-10-27 23:15 UTC

README

This is the core of the Pionia Framework

Installation

composer require pionia/pionia-core

This is meant for the core developers of the Pionia Core not the framework itself. If you are looking to use or get started with the framework, please find the Pionia Framework here

Usage

Go to the documentation here

Road Map for the Pionia Framework(Subject to change)

Coverage 25/26 -- 96%

Packages covered

  • Pionia\Core
  • Authentication
  • Database
  • File System
  • Mail
  • Session
  • Validation
  • Templating engine
  • Routing
  • Middleware
  • Request
  • Response
  • Services
  • Switches
  • Config and Environments
  • Logging
  • Cors
  • HTTP Kernel
  • Events
  • Console
  • Cache
  • Exception handling
  • Helper functions
  • CLI Bootstrapping
  • Uploading and Serving Media Files
  • Collections

Setting up the this project

Prerequisites

  • PHP 8.1 or higher
  • Composer
  • Git
  • Any Editor/IDE of your choice preferably PHPStorm or Intellij IDEA

Installation

Clone the repository

git clone https://github.com/PioniaPHP-project/Pionia.git

Change directory to the project folder

cd Pionia

Install the dependencies

composer install

Running the tests

composer test

Compiling the core dev docs

composer document

Contributing

Please read the CONTRIBUTING.md file for more information on how to contribute to this project.

Authors

License

MIT License