Contributors: conner_bw, greatislander, steelwagstaff, arzola, fdalcin
Tags: pressbooks, plugin, scaffolding
Requires at least: 6.5
Tested up to: 6.5 \
Stable tag: 0.1.0 \
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
Scaffolding for a Pressbooks plugin.
This is not a plugin, but a tool that helps you scaffold a 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.
Configure GitHub Action deploys (instructions to come).
Configure Transifex project and localization (instructions to come).
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
Controllers are responsible for handling requests and returning responses. They are located in the src/Controllers
directory.
Database migrations are located in the src/Database/Migrations
directory.
Composed Views like WP_List_Table are located in the src/Views
directory.
Blade templates are located in the resources/views/{namespace}
directory.
Models are located in the src/Models
directory.
Please see the CHANGELOG file for more information.