Skip to content

Latest commit

 

History

History
98 lines (65 loc) · 3.83 KB

readme.md

File metadata and controls

98 lines (65 loc) · 3.83 KB
Raw

VajraWP - A WordPress Plugin Starter

Plugin Version License

A WordPress Plugin Scaffold for Modern Plugins.
Lightweight, customizable and beautiful by default.


In Dev by Krishna Kant 👋

Overview

This is a WordPress Plugin scaffold to help you create awesome plugins without having to build everything from scratch. Its a growing pain in WordPress that even in 2023 you still have to create your own settings, dashboards, onboarding, file autoloaders and what not. So here's a quick way to kickstart a plugin with almost everything you need.

Why almost? As you start to make this plugin yours it is bound to have that one cool feature missing that you want, so why not add that to this yourself. Welcome to opensource, even if its your first time contributing, I'll make sure that you feel like home :)

Features

  • 🚀 Built in React App for Admin
  • ⚙️ Settings UI and Data Store - Customizable UI fields with Data Store
  • 🏄‍️ Onboarding and Changelog UI - In Admin Changelog and Onboarding UI
  • 🏗️ Blocks Development Workflow
  • 📂 PHP Autoloader
  • ✨ TailwindCSS Support

Installation

Step 1

Make sure you have PHP, Composer and NodeJS installed. And then run the following bash command -

npm run install-scripts && npm run build:all

Step 2

Now watch the below video to learn how to use most of the provided features.

youtube.com/watch?v=IUyJcUzROGc

Step 3

Once you have watched it, just run one of the below commands and start developing ⚡️

# For Dashboard App
npm run dev:dashboard

# OR For Block Development
npm run dev:blocks

Documentation (WIP)

Find the full API reference on official documentation.

Contribute

Thank you for thinking about contributing to VajraWP! If you're unsure of anything, feel free to submit an issue or pull request on any topic. The worst that can happen is that you'll be politely directed to the best location to ask your question or to change something in your pull request. There are a variety of options for how you can help:

  • If you think there is a cool or important feature missing, just add a pull request.
  • If you found a bug, file a report here.

Inspiration

This plugin is heavily influenced by plugins like Jetpack, WooCommerce, and many more. Ultimately becoming a mix of all worlds!

Sponsor

If you are really interested in the ongoing development of this project or just consider my work worth supporting, you can become a sponsor via the below links -

Security

Need to report a security vulnerability? Email us at [email protected].

License

VajraWP is licensed under GNU General Public License v2 (or later).