# howdy **Repository Path**: java_doc/howdy ## Basic Information - **Project Name**: howdy - **Description**: No description available - **Primary Language**: Unknown - **License**: GPL-3.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-01-22 - **Last Updated**: 2026-01-22 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 👋 Howdy **Howdy** is a starter kit for creating an ambitious plugin for WordPress® by providing a boilerplate structure with pre-configured tools to help you start developing the plugin with modern PHP practices. ## Features * [PSR-4 Autoloading](https://www.php-fig.org/psr/psr-4/) with [Composer](https://getcomposer.org), for automatic class loading. * [PHP Code Sniffer (PHPCS)](https://github.com/PHPCSStandards/PHP_CodeSniffer), for PHP code style checking. * [PHP-Scoper](https://github.com/humbug/php-scoper), for scoping the plugin dependencies. * [ESLint](https://eslint.org/), for JavaScript code style checking. * [@wordpress/scripts](https://www.npmjs.com/package/@wordpress/scripts), for JavaScript tooling, e.g. ESLint, and asset compilation. * [@syntatis/kubrick](https://www.npmjs.com/package/@syntatis/kubrick), for building classic WordPress® admin application interface with React.js. ## Requirements * PHP 7.4 or higher * [Composer](https://getcomposer.org) * Node.js 20 or higher ## Usage To start a new plugin project, simply run: ```bash composer create-project syntatis/howdy ``` This command will set up the boilerplate files in a directory named `howdy`. It will ask you a few questions to customize your project, like the plugin slug, name, and the PHP namespaces. Once you've input all these details, it will scope the plugin dependency libraries to prevent naming conflicts with other plugins which may also be using the same libraries. You can find the scoped dependencies in the `dist/autoload` directory. > [!TIP] > Want to create the project in a different folder? Just add the directory name at the end of the command, like this: > ```bash > composer create-project syntatis/howdy awesome-plugin > ``` > This will create the project in the `awesome-plugin` directory. > For more details, check out the [Composer CLI documentation](https://getcomposer.org/doc/03-cli.md#create-project). After the project setup is complete, run the following command within your plugin directory to start compiling the assets, like the stylesheets and the JavaScript files. It will also watch for the changes within the files and recompile them automatically. ```bash npm install npm run start ``` ## Commands Commands are available to help you with the development process. You can run these commands from the root of your plugin directory.
| Command | Description |
|---|---|
composer scope |
Scopes the plugin Composer dependencies to prevent namespace conflicts with other plugins. |
composer build |
Run the plugin build process for production i.e. updating the translation POT file, and prefixing namespace. |
composer zip |
Creates a zip file of the plugin for distribution. Based on the Composer archive. Refer to the documentation for the available options to run the command. |
npm run start |
Compiles the assets, like the stylesheets and the JavaScript files, and watches for the changes within the files to recompile them automatically. |
npm run build |
Builds the assets for production. It compiles the assets, like the stylesheets and the JavaScript files, and minifies them for production use. |