OOWPrise is a WordPress starter theme that heavily employs object-oriented programming techniques and modern WordPress tools.
Documentation can be found here https://gturpin-dev.github.io/OOWPrise
You can install OOWPrise using the following methods:
composer create-project gturpin/oowprise
After that, you must install the theme's dependencies :
composer install
npm install
# Or with the provided Makefile
make init
You have a built-in development environment that you can use to develop your theme without a WP installation.
It requires Docker and wp-env to be installed on your machine.
You have access to the following commands :
wp-env start # Start the development environment
wp-env stop # Stop the development environment
# Or with the provided Makefile
make server:start
make server:stop
To build assets, you can use the following commands :
npm run watch:theme # Watch CSS/JS assets for development
npm run build:theme # Build CSS/JS assets for production
# Or with the provided Makefile
make watch:theme
make build:theme
OOWPrise comes with a built-in block system that allows you to create blocks in a simple way.
You can create a new block using the following command :
make create-block
# Or with slug parameter to skip the prompt
make create-block slug=your-block-slug
This command will create a new block in the resources/blocks
directory. Refer to the @wordpres/create-block documentation for more information.
To build your block, you can use the following command :
npm run watch:blocks # Watch blocks for development
npm run build:blocks # Build blocks for production
# Or with the provided Makefile
make watch:blocks
make build:blocks
You can deploy your theme using the following command :
npm run theme-zip
# Or with the provided Makefile
make zip
This command will create a zip archive of your theme that can be uploaded to a WordPress installation.
TODO: Write contribution guidelines
TODO: Write credits
The OOWPrise starter theme is open-sourced software licensed under the MIT license.