phpexperts / mini-api-base
A quick and easy standard PHP skeleton.
Requires
- php: >=8.1
- ext-json: *
- 0.0.0/composer-include-files: ^1.6
- illuminate/database: ^11.37
- illuminate/events: ^11.37
- illuminate/filesystem: ^11.37
- minicli/minicli: ^4.2
- pecee/simple-router: ^5.4
- phpexperts/console-painter: ^1.1
- phpexperts/laravel-env-polyfill: ^1.7
- phpexperts/rest-speaker: ^2.7
- phpexperts/simple-dto: ^3.7
Requires (Dev)
README
MiniApiBase is a PHP Experts, Inc., Project meant to ease the creation of new API projects.
It strives to conform to the Standard PHP Skeleton (https://github.com/php-pds/skeleton) wherever possible.
Read On Structuring PHP Projects for more.
The configurer was inspired by https://www.binpress.com/building-project-skeletons-composer/
It includes everything you need for a modern lightweight PHP API server:
- Minimum PHP version of v8.1.
- minicli/minicli (PHP Experts' fork)
- pecee/simple-router
- phpexperts/console-painter
- phpexperts/laravel-env-polyfill
- phpexperts/rest-speaker
- phpexperts/simple-dto
Installation
Via Composer
composer create-project phpexperts/mini-api-base api.my.site
Usage
Install a project, then remove the directories you won't need, like bin.
You should definitely edit the LICENSE to be specific to your project and update the tags at the top of the README.md.
Use cases
✔ Rapidly start up a project right.
✔ Less time spent on boilerplating a git repo.
✔ Conforms to the most widely-deployed PHP layout.
✔ Fully compatible with the Bettergist Collective recommendation.
Testing
phpunit --testdox
Contributors
Theodore R. Smith theodore@phpexperts.pro
GPG Fingerprint: 4BF8 2613 1C34 87AC D28F 2AD8 EB24 A91D D612 5690
CEO: PHP Experts, Inc.
License
MIT license. Please see the license file for more information.