https://github.com/joanrodas/plubo

Simple WordPress plugin boilerplate
https://github.com/joanrodas/plubo

boilerplate plugin wordpress wordpress-boilerplate wordpress-development wordpress-plugin

Last synced: 3 days ago
JSON representation

Simple WordPress plugin boilerplate

• Host: GitHub
• URL: https://github.com/joanrodas/plubo
• Owner: joanrodas
• License: gpl-3.0
• Created: 2022-03-31T17:12:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T22:54:29.000Z (4 months ago)
• Last Synced: 2024-05-28T16:44:16.603Z (4 months ago)
• Topics: boilerplate, plugin, wordpress, wordpress-boilerplate, wordpress-development, wordpress-plugin
• Language: PHP
• Homepage: https://plubo.dev
• Size: 6.27 MB
• Stars: 19
• Watchers: 4
• Forks: 2
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  



[![GitHub stars](https://img.shields.io/github/stars/joanrodas/plubo?style=for-the-badge)](https://github.com/joanrodas/plubo/stargazers)

Plubo is a really simple WordPress plugin boilerplate created to speed up plugin development.

✔️  Use Blade views and directives from the start\

✔️  Add styles in SCSS\

✔️  JavaScript router lets you add scripts on specific WordPress templates (based on body tags) and on specific shortcode tags




## Getting started

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/joanrodas/plubo/On%20Template?label=build&style=for-the-badge)

![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability-percentage/joanrodas/plubo?style=for-the-badge)

[![GitHub issues](https://img.shields.io/github/issues/joanrodas/plubo?style=for-the-badge)](https://github.com/joanrodas/plubo/issues)

[Read the Docs](https://www.plubo.dev/docs/)

There are 2 options to start using Plubo:

### 1. As a GitHub template

If you intend to use GitHub for your project, your best option is to create a new repo using this one as a template, just clicking the ***Use this template*** button.

When the new repo is ready, you can just clone it, run ``composer install`` and start programming.

> When using Plubo as a template, a pipeline will be executed right after the repo creation, modifiyng the filenames and classes to match your new project name.

 The pipeline files will be autoremoved.

### 2. With composer

```bash

composer create-project joanrodas/plubo 

```

> After creating the project, use the plubo-cli to create new classes, libraries and utilities to your project.




## Add new classes with plubo-cli

Install the CLI: https://github.com/joanrodas/plubo-cli/

```bash

plubo-cli add cpt

plubo-cli add fields

plubo-cli add routes

plubo-cli add admin-menus

plubo-cli add ajax

plubo-cli add endpoints

plubo-cli add post-actions

plubo-cli add roles

plubo-cli add shortcodes

plubo-cli add taxonomies

```




## Contributions

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=for-the-badge)](https://github.com/joanrodas/plubo/issues)

[![GitHub license](https://img.shields.io/github/license/joanrodas/plubo?style=for-the-badge)](https://github.com/joanrodas/plubo/blob/main/LICENSE)

Feel free to contribute to the project, suggesting improvements, reporting bugs and coding.