https://github.com/phpexpertsinc/miniapibase
A drop-dead simple way to bootstrap lightweight API server in PHP.
https://github.com/phpexpertsinc/miniapibase
Last synced: 11 months ago
JSON representation
A drop-dead simple way to bootstrap lightweight API server in PHP.
- Host: GitHub
- URL: https://github.com/phpexpertsinc/miniapibase
- Owner: PHPExpertsInc
- Created: 2025-01-02T08:59:38.000Z (over 1 year ago)
- Default Branch: trunk
- Last Pushed: 2025-01-07T14:09:12.000Z (over 1 year ago)
- Last Synced: 2025-05-08T20:58:44.847Z (about 1 year ago)
- Language: PHP
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.cc-by-nd.actual.md
Awesome Lists containing this project
README
# MiniApiBase Project
[![Maintainability]()]()
[![Test Coverage]()]()
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**](https://blog.nikolaposa.in.rs/2017/01/16/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)](https://github.com/PHPExperts-Contribs/minicli)
* [pecee/simple-router](https://github.com/skipperbent/simple-php-router)
* [phpexperts/console-painter](https://github.com/PHPExpertsInc/ConsolePainter)
* [phpexperts/laravel-env-polyfill](https://github.com/PHPExpertsInc/Laravel57-env-polyfill)
* [phpexperts/rest-speaker](https://github.com/PHPExpertsInc/RESTSpeaker)
* [phpexperts/simple-dto](https://github.com/PHPExpertsInc/SimpleDTO)
## Installation
Via Composer
```bash
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
```bash
phpunit --testdox
```
## Contributors
[Theodore R. Smith](https://www.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](LICENSE.mit.md) for more information.