woocommerce/plugins/woocommerce-admin/bin/starter-pack/README.md

25 lines
880 B
Markdown
Raw Normal View History

2020-11-16 00:04:53 +00:00
# Create Extension
2020-11-16 00:07:14 +00:00
Scaffold a modern JavaScript WordPress plugin with WooCommerce tooling.
2020-11-16 00:04:53 +00:00
## Includes
- [wp-scripts](https://github.com/WordPress/gutenberg/tree/master/packages/scripts)
- [WooCommerce Dependency Extraction Webpack Plugin](https://github.com/woocommerce/woocommerce-admin/tree/main/packages/dependency-extraction-webpack-plugin)
- [WooCommerce ESLint Plugin with WordPress Prettier](https://github.com/woocommerce/woocommerce-admin/tree/main/packages/eslint-plugin)
### Usage
At the root of a [WooCommerce Admin](https://github.com/woocommerce/woocommerce-admin) installation, run the create extension command.
```
npm run create-wc-extension
```
2020-11-16 00:07:14 +00:00
The script will create a sibling directory by a name of your choosing. Once you change directories into the new folder, install dependencies and start a development build.
2020-11-16 00:04:53 +00:00
```
npm install
npm start
```