ready to use

Author: devkabir

build.sh

@@ -21,36 +21,26 @@ progress_message "Preparing build directory..."
 rm -rf ./"$plugin_name" ./"$plugin_name".zip
 mkdir ./"$plugin_name"
 
-
-# build assets
-progress_message "Building admin template..."
-npm --prefix ./assets run build
-
 # copy all files for production
 progress_message "Copying files for production..."
-cp -R ./composer.json ./*.php src assets/dist  readme.txt ./"$plugin_name"/ --parents
+cp -R ./composer.json ./*.php src assets  readme.txt ./"$plugin_name"/ --parents
 
 # Install PHP dependencies
 progress_message "Installing PHP dependencies..."
 composer install --working-dir=./"$plugin_name" --no-dev
 rm ./"$plugin_name"/composer.json
 
-# Remove dev data
-progress_message "Removing dev data..."
-sed -i '67,70d;' ./"$plugin_name"/src/Controllers/AdminController.php
-rm ./"$plugin_name"/assets/dist/index.html
-
 # Add index.php to every directory
 progress_message "Adding index.php to every directory..."
 find ./"$plugin_name" -type d -exec sh -c "echo '<?php // silence' > {}/index.php" \;
-./vendor/bin/phpcbf ./"$plugin_name"/src --standard=WordPress-Extra -s --report=source
+
 # Create zip archive
 progress_message "Creating zip archive..."
+# TODO: update zip path based on your OS.
 "C:\Program Files\7-Zip\7z.exe" a ./"$plugin_name".zip ./"$plugin_name"/*
 
 # Revert changes for production
 progress_message "Reverting changes..."
-rm -rf ./assets/dist
 rm -rf ./"$plugin_name"
 
 # Completion message

install.sh

@@ -38,16 +38,8 @@ find ./ -type f \( -name "*.php" -o -name "*.js" -o -name "*.json" -o -name "*.h
 # run composer dump-autoload
 progress_message "Running composer dump-autoload..."
 composer dump-autoload
-# cd into assets
-progress_message "Building assets..."
-cd ./assets
-# run npm install on assets dir
-npm install 
-# run npm run build on assets dir
-npm run build 
 # delete this file
-progress_message "Deleting install.sh..."
-cd ..
-rm install.sh
-rm -rf .github
-rm -rf .idea
+progress_message "Deleting unnecessary files..."
+rm -rf ./.github
+rm ./readme.md
+rm ./install.sh

readme.md

@@ -1,53 +1,41 @@
-# WordPress Plugin
+# WordPress Plugin - PHP
 
-A simple WordPress plugin boilerplate for Admin related tasks.
-
-## Technologies
-
-- [**vue.js**](https://vuejs.org/) The Progressive JavaScript Framework.
-- [**Vite**](https://vitejs.dev/) Next Generation Frontend Tooling.
-- [**tailwindcss**](https://tailwindcss.com/) Rapidly build modern websites without ever leaving your HTML.
-- [**Notyf**](https://github.com/caroso1222/notyf) A minimalistic JavaScript library for toast notifications.
+This is a simple template (called a "boilerplate") to help you build your own WordPress plugin. You don't need to know about fancy tools to use it, but if you want, you can add extra things like **Alpine.js**, **Vue.js**, or other libraries to make it even cooler!
 
 ### Features
 
-- Check used [Technologies](#technologies) features.
-- It replaces all placeholder strings during plugin creation.
-- It generates independent styles for backend without any conflict with WordPress core and any plugin or themes.
-- It makes zip for test plugin throughout a team by one command.
-- You can manage your plugin license and support with this. N.B. You will need a management system. you can check out my [WordPress Plugin Management System](https://github.com/devkabir/wordpress-plugin-management-system)
+- It helps you change placeholder names when creating your plugin, so you don’t have to worry about replacing everything manually.
+- It keeps your plugin’s style separate from the rest of WordPress and other plugins, so it won’t mess anything up.
+- You can make a **ZIP** file of your plugin easily so you can share it with your friends or team with just one command.
+- If you want, you can manage plugin licenses and support. To do that, you will need a system. You can check out my [WordPress Plugin Management System](https://github.com/devkabir/wordpress-plugin-management-system).
 
-## Requirements
+## What You Need (Requirements)
 
-- **node.js** v18.8.0
-- **npm** v8.18.0
-- **PHP** v7.4 or higher
-- **VS Code extension** check recommendations.
-- **bash** Any bash script compatible terminal. You may use Git Bash for this. For **Laragon** Users, You have already all tools, just add to path.
+- **PHP** version 7.4 or higher (this is the programming language WordPress uses).
+- **VS Code** (this is a free program you can use to write your code). Make sure to check for any recommended extensions.
+- **Bash Terminal** (this helps you run commands). If you have **Git Bash** or **Laragon**, you're all set!
 
-## For Fresh Start
+## Getting Started (Fresh Start)
 
-- Dev version with dummy content
+To start making your own plugin, follow these steps:
+
+1. Open a **Bash** terminal (or **Git Bash**).
+2. Run this command (copy and paste it):
 
 ```bash
-composer create-project devkabir/wordpress-plugin:dev-only-admin <your-plugin-name>
+composer create-project devkabir/wordpress-plugin:dev-only-php <your-plugin-name>
 ```
 
-## Documentation
+3. Replace `<your-plugin-name>` with what you want to call your plugin.
+4. Hit **Enter** and let it do its magic!
+5. You’re ready to start creating something amazing for WordPress!
+
+Happy coding!
 
-- [How to install](https://github.com/devkabir/wordpress-plugin/wiki#how-to-install)
-- [Project Organization](https://github.com/devkabir/wordpress-plugin/wiki#project-organization)
-- Components
-  - [List](https://github.com/devkabir/wordpress-plugin/wiki/DataList)
-  - [Table](https://github.com/devkabir/wordpress-plugin/wiki/DataTable)
+## Build
 
-## Recommended Plugins
 
-- For nice error page, [WordPress Debugger](https://github.com/devkabir/wordpress-plugin-debugger)
 
-## For visual learners
+## Extra Plugins (Recommended)
 
-- How to start
-  - [![Video Title](https://img.youtube.com/vi/ZXu4Y2Wt3-k/0.jpg)](https://www.youtube.com/watch?v=ZXu4Y2Wt3-k)
-- How to debug
-  - [![Video Title](https://img.youtube.com/vi/rdTug4q5tEM/0.jpg)](https://www.youtube.com/watch?v=rdTug4q5tEM)
+If you want some extra tools to help with debugging (fixing errors), you can use [Zero Debugger](https://github.com/devkabir/0-debugger).