Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matapatos/wp-fastendpoints-my-plugin
Sample plugin that demonstrates how to use FastEndpoints
https://github.com/matapatos/wp-fastendpoints-my-plugin
Last synced: 10 days ago
JSON representation
Sample plugin that demonstrates how to use FastEndpoints
- Host: GitHub
- URL: https://github.com/matapatos/wp-fastendpoints-my-plugin
- Owner: matapatos
- License: mit
- Created: 2024-05-02T09:58:15.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-17T15:25:21.000Z (6 months ago)
- Last Synced: 2024-05-17T16:37:21.704Z (6 months ago)
- Language: PHP
- Size: 55.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quick Start - WP-FastEndpoints
**MyPlugin** is a WordPress sample plugin that demonstrates how to use FastEndpoints.
- Follow up our guide at **[Quick Start FastEndpoints Wiki »](https://github.com/matapatos/wp-fastendpoints/wiki/Quick-start)**
## Features
- Sample router to manipulate blog posts (create, update, retrieve and delete)
- Sample JSON schemas to validate those requests. For more schemas properties visit [json/opis »](https://opis.io/json-schema/2.x/)
- Out of the box Unit tests + Integration tests using [pestphp](https://pestphp.com/) thanks to [dingo-d/wp-pest](https://github.com/dingo-d/wp-pest)
- PHP code style fixer using [laravel/pint](https://github.com/laravel/pint)
- Composer scripts for running tests + linter + setting up WordPress
## Requirements
- PHP 8.1+
- WordPress 6.x
- [matapatos/wp-fastendpoints](https://packagist.org/packages/matapatos/wp-fastendpoints)
## Installation
Add plugin to WordPress and then install all the dependencies:
```bash
composer install
```
## Lint
```bash
composer test:lint
```
## Running tests
```bash
composer test # Runs linter + unit and integration tests
composer test:unit # Runs unit tests
composer test:integration # Runs integration tests
```
### Setup WordPress
Please note that before running the integration tests you have to specify the WordPress
version you want to use, via:
```bash
composer setup:wp:6.0 # For the latest 6.0.x version
composer setup:wp:6.1 # For the latest 6.1.x version
composer setup:wp:6.2 # For the latest 6.2.x version
composer setup:wp:6.3 # For the latest 6.3.x version
composer setup:wp:6.4 # For the latest 6.4.x version
composer setup:wp:latest # For the latest x.x.x version
```
### Known errors
#### WordPress 6.5.x requires MySQL 5.5.5 or higher
Since WordPress have bumped the minimum MySQL version from 5.0 to 5.5.5 in WordPress
6.5.x the integration tests might not work for the latest version until
this [PR changes is released](https://github.com/aaemnnosttv/wp-sqlite-db/pull/61).
In other words, `composer setup:wp:latest` might not work so use `composer setup:wp:6.4`
instead.
MyPlugin was created by **[André Gil](https://www.linkedin.com/in/andre-gil/)** and is open-sourced software licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.