Light

gturpin-dev / oowprise Goto Github PK

View Code? Open in Web Editor NEW

5.0 1.0 0.0 1.58 MB

OOWPrise is a WordPress starter theme that heavily employs object-oriented programming techniques and modern WordPress tools.

Home Page: https://gturpin-dev.github.io/OOWPrise/

License: MIT License

CSS 0.50% PHP 95.24% Makefile 3.53% JavaScript 0.40% SCSS 0.34%

design-patterns oop oop-principles php starter-template starter-theme wordpress wordpress-theme

oowprise's Introduction

OOWPrise

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

Installation

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

Usage

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

Documentation

Build assets

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

Gutenberg blocks

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

Deployment

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.

Contributing

TODO: Write contribution guidelines

Credits

TODO: Write credits

License

The OOWPrise starter theme is open-sourced software licensed under the MIT license.

oowprise's People

Contributors

Stargazers

Watchers

oowprise's Issues

Beautify README

Update the README to add emojis and clearer informations about the project and basics of how to use it
Also link it to the documentation

Add Framework class for API Route

Add Factory/Interface to the framework to easily handle Custom API endpoints in a service container

Set up documentation

Set up the documentation with docsify or TailwindUI template

Adding a make command like make:service_provider

This command will create a ready-to-use ServiceProvider class in src
It should provide an arg to customize the name and path

Check if theme path/uri works if it is used as a child theme

I OOWPrise theme is used as a child theme we need to add some functions to override the theme init path/uri because now they are called with "template".
Or find a way to always get referenced to the current theme eg: not only "stylesheet"

Remove CustomizerServiceContainer

The Customizer Service Container still be there for early tests and have to be removed
Furthermore the Customizer will disappear in WP so not needed to create a Factory around it

Switch all register_ methods to add_ to simplify usage of AssetsEnqueue

At the moment, these methods are register_ and this is not super clear because we also call register method on the class itself to register all of enqueues

Add Request class to handle API Request

Add helpers class to the framework to easily handle external API Request in a service container
This would be a wrapper of wp_remote_get / post and can handle the response maybe with a Response class

Rename AssetsEnqueuer class to AssetsEnqueue

For more consistency and readability

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.