WordPress Plugin

Contributors: devkabir
Donate link: https://example.com/
Tags: wordpress, plugin
Requires at least: 5.3
Tested up to: 6.1.1
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

A simple WordPress plugin boilerplate

Description

This is a foundation for building WordPress plugins. It provides a structured, organized and maintainable codebase for plugin developers to build upon. This boilerplate includes best practices for security, performance, and extensibility, as well as tools for testing and deployment. It follows the WordPress coding standards and is built using object-oriented design principles. By using this, developers can focus on building their plugin's unique functionality, rather than worrying about the underlying code structure.

Technologies

• Vite Next Generation Frontend Tooling.
• tailwindcss Rapidly build modern websites without ever leaving your HTML.
• vue.js The Progressive JavaScript Framework.
• Notyf A minimalistic JavaScript library for toast notifications.
• jQuery A minimalistic JavaScript library for toast notifications.

Features

• Check used Technologies features.
• Can generate independent CSS rules for the frontend and admin that work with almost any theme without conflict.
• The frontend and backend teams can work on the same plugin at the same time without any issues.
• By using a bash script, you can create a WordPress.org build package. As a result, your source code and production code will be distinct.
• Jquery is supported by frontend scripts. If your developer is unfamiliar with vue.js, he can generate admin and website assets with jquery.
• Shortcode generator can collect assets dynamically. All you have to do is pass shortcode tag in Shortcode Class.
• It will load classes based on current screen of WordPress

25/02/2023

• Admin Dashboard
  • added datatable and datalist component
  • added .env support for development and production
  • added axios as default http client
• Plugin
  • Upgraded php 5.6 to 7.4
  • added rest api for admin panel
  • updated log system with WordPress default timezone
  • added cors support for development.
  • started license management system, need to improve.
• Scripts
  • added build script. It will make a zip file for production build. Also return source to development

Requirements

• node.js v18.12.1
• npm v9.2.0
• PHP v5.6

Installation

For PHP Developer,

1. Go to your plugins folder of your local WordPress installation and run

composer create-project devkabir/wordpress-plugin your-plugin-name

2. run for open codes

cd your-plugin-name
code .

For Frontend Developer,

1. For working on admin ui

cd assets/admin
npm run dev

2. admin ui will open on http://localhost:5173/

The same goes for website assets

Build and Deploy

1. Create a GitHub repository for production. You can add GitHub action to automate deployment of your plugin.
2. Run deploy.sh in your terminal.
3. Enter your github user name and the name of the repository you created in step 1.

It will clone your production repository and push the most recent code.

Screenshots

1. Admin UI