pressbooks/pressbooks-plugin-scaffold

This package is abandoned and no longer maintained. No replacement package was suggested.

A scaffold for Pressbooks plugins.

0.5.0 2024-01-25 19:57 UTC

Requires

• php: ^8.1
• illuminate/pagination: ^8.83
• kucrut/vite-for-wp: ^0.5.2

Requires (Dev)

• laravel/pint: ^1.10.6
• pressbooks/pressbooks: dev-dev
• yoast/phpunit-polyfills: ^1.0.5

GPL-3.0-or-later

• Book Oven Inc.

• publishing
• ebooks
• webbooks

README

Contributors: conner_bw, greatislander, steelwagstaff, arzola, fdalcin
Tags: pressbooks, plugin, scaffolding
Requires at least: 6.5
Tested up to: 6.5
Stable tag: 0.6.0
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html

Scaffolding for a Pressbooks plugin.

Description

This is not a plugin, but a tool that helps you scaffold a plugin.

Installation

Create Plugin

Run composer create-project pressbooks/pressbooks-plugin-scaffold <your-plugin-slug>.

Run php configure.php script to set up your newly created plugin. This will replace all pressbooks-plugin-scaffold and its variants throughout all the files.

Optional Steps

Configure GitHub Action deploys (instructions to come).

Configure Transifex project and localization (instructions to come).

Helpful Commands

composer standards: check PHP coding standards with Laravel Pint
composer fix: fix PHP coding standards with Laravel Pint
composer test: run unit tests with PHPUnit
composer readme: generate a Markdown readme from readme.txt
npm run dev: build assets for development
npm run build: build assets for distribution

Directory Structure

Controllers

Controllers are responsible for handling requests and returning responses. They are located in the src/Controllers directory.

Database

Database migrations are located in the src/Database/Migrations directory.

Views

Composed Views like WP_List_Table are located in the src/Views directory.

Blade templates are located in the resources/views/{namespace} directory.

Models

Models are located in the src/Models directory.

Changelog

0.6.0

Upgrade Notice

Pressbooks Plugin Scaffold 0.6.0 requires PHP 8.1, Pressbooks >= 6.16.0, and WordPress >= 6.5