Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-admin/README.md

38 lines
2.2 KiB
Markdown
Raw Normal View History

Update woo-dash naming to new wc-admin name (https://github.com/woocommerce/woocommerce-admin/pull/183)
2018-07-10 12:48:06 +00:00
# WooCommerce Admin
Add an admin page, build a simple component + filters
2018-04-17 23:51:48 +00:00
Update woo-dash naming to new wc-admin name (https://github.com/woocommerce/woocommerce-admin/pull/183)
2018-07-10 12:48:06 +00:00
This is a feature plugin for a modern, javascript-driven WooCommerce Admin experience.
Add an admin page, build a simple component + filters
2018-04-17 23:51:48 +00:00
Add "in progress" banner to readme (https://github.com/woocommerce/woocommerce-admin/pull/211) * Update README * Update where to get v3 of the WC REST API
2018-07-17 15:50:11 +00:00
---
:warning: This project is in active development, and is not ready for general use. You can follow the features in development by looking at the [project's issues](https://github.com/woocommerce/wc-admin/issues). **We do not recommend running this on production sites.**
---
Add Gutenberg & WooCommerce prereq to the README (https://github.com/woocommerce/woocommerce-admin/pull/1) * Add Gutenberg prereq to the README I installed `woo-dash` without Gutenberg installed and ended up getting a fatal error. We should probably fix that as well/handle that better, but if we are going to rely on Gutenberg for the feature plugin we should mention it in the README. * Add mention of WooCommerce as a prereq
2018-05-02 18:28:59 +00:00
## Prerequisites
Docs: Remove REST API feature branch requirement. (https://github.com/woocommerce/woocommerce-admin/pull/445) * Remove REST API feature branch requirement. * npm run docs
2018-09-19 17:55:44 +00:00
[Gutenberg](https://wordpress.org/plugins/gutenberg/) and [WooCommerce](https://wordpress.org/plugins/woocommerce/) should be installed prior to activating the WooCommerce Admin feature plugin.
Add Gutenberg & WooCommerce prereq to the README (https://github.com/woocommerce/woocommerce-admin/pull/1) * Add Gutenberg prereq to the README I installed `woo-dash` without Gutenberg installed and ended up getting a fatal error. We should probably fix that as well/handle that better, but if we are going to rely on Gutenberg for the feature plugin we should mention it in the README. * Add mention of WooCommerce as a prereq
2018-05-02 18:28:59 +00:00
Fix React warnings for nested components/className (https://github.com/woocommerce/woocommerce-admin/pull/83) * Fix class/className warning * Fix nested `a` warning * Add note about SCRIPT_DEBUG
2018-05-23 18:01:41 +00:00
For better debugging, it's also recommended you add `define( 'SCRIPT_DEBUG', true );` to your wp-config. This will load the unminified version of all libraries, and specifically the development build of React.
Add an admin page, build a simple component + filters
2018-04-17 23:51:48 +00:00
## Development
After cloning the repo, install dependencies with `npm install`. Now you can build the files using one of these commands:
- `npm run build` : Build a production version
Build Tools: Add precommit/prepush scripts, install if outdated (https://github.com/woocommerce/woocommerce-admin/pull/34) * Add helper scripts from calypso * Add the pre-push hook to protect master * Add required packages * Update README * Remove unused package
2018-05-10 19:17:28 +00:00
- `npm start` : Build a development version, watch files for changes
Update README.md
2018-11-15 21:13:35 +00:00
- `npm run build:release` : Build a WordPress plugin ZIP file (`wc-admin.zip` will be created in the repository root)
Add an admin page, build a simple component + filters
2018-04-17 23:51:48 +00:00
There are also some helper scripts:
- `npm run lint` : Run eslint over the javascript files
Build: Update i18n generation to combine JS + PHP translations (https://github.com/woocommerce/woocommerce-admin/pull/481) * Generate the PHP translations file from the POT file after building the project * Remove unused tasks * Update i18n task to generate JS pot file, then convert that to PHP, then run grunt php pot generation * Update docs * Pipe babel file output to null, not entire output of command Helps with debugging the babel command itself
2018-09-26 14:23:55 +00:00
- `npm run i18n` : A multi-step process, used to create a pot file from both the JS and PHP gettext calls. First it runs `i18n:js`, which creates a temporary `.pot` file from the JS files. Next it runs `i18n:php`, which converts that `.pot` file to a PHP file. Lastly, it runs `i18n:pot`, which creates the final `.pot` file from all the PHP files in the plugin (including the generated one with the JS strings).
Adding npm test to "helper scripts" section. (https://github.com/woocommerce/woocommerce-admin/pull/1087)
2018-12-14 00:47:13 +00:00
- `npm test` : Run the JS test suite
Add privacy notice regarding wp.com
2018-10-17 20:49:06 +00:00
## Privacy
If you have enabled WooCommerce usage tracking ( option `woocommerce_allow_tracking` ) then, in addition to the tracking described in https://woocommerce.com/usage-tracking/, this plugin also sends information about the actions that site administrators perform to Automattic - see https://automattic.com/privacy/#information-we-collect-automatically for more information.
Add markdown docs with details on contributing
2018-10-31 23:12:11 +00:00
## Contributing
There are many ways to contribute – reporting bugs, feature suggestions and fixing bugs. For full details, please see [CONTRIBUTING.md](./CONTRIBUTING.md)