Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/arukaraz/akz-wp-react-kit/archive/refs/heads/main.zipNo built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.
AK WP React Kit
A starter template to build React-powered WordPress plugins.
STACK
- MUI material
- Tanstack/react query
- @wordpress/api-fetch
- Typescript
- Production Build
- REST API Integration
GETTING STARTED
1. Installation
- Clone the repository to /wp-content/plugins/:
Or download and upload the plugin files to /wp-content/plugins/akz-wp-react-kit.
- Rename the folder name akz-wp-react-kit to your plugin folder.
- Install dependencies
2. Renaming the Plugin
You must change the plugin folder and file names. Furthermore, adjust the constants, variables, classes, text domain, and functions inside the plugin to match your plugin’s name. For example, if your plugin is called my-cool-plugin, then:
i. Renaming using command
Go to the .bin directory within the plugin folder and open the initial-rename.js file. Apply the following modifications:
- your-amazing-plugin-name
- youramazingpluginname
- YOURAMAZINGPLUGINNAME
- YOUR-AMAZING-PLUGIN-NAME
- Your-Amazing-Plugin-Name
- YourAmazingPluginName
- YourAmazingPluginName
With:
- my-cool-plugin
- mycoolplugin
- MYCOOLPLUGIN
- MY-COOL-PLUGIN
- My-Cool-Plugin
- MyCoolPlugin
- MyCoolPlugin
Now Run npm run in