woocommerce/plugins/woocommerce-admin
Kelly Dwan 62276fb361 Add visual component docs from markdown examples (https://github.com/woocommerce/woocommerce-admin/pull/470)
* Remove content from README, leaving only the example

* Rename edited READMEs

* Add a devdocs page rendering from markdown example files

* Add more components to devdocs

* Add the rest of the component examples

* Add navigation to single components, show generated readme on single component view

* Style devdocs like calypso

* Split devdocs into two columns at “desktop” sizes

* Update segmented selection example

* Update link

* Add header to avoid notices error
2018-09-24 11:36:35 -04:00
..
bin Documentation: Move topic READMEs into docs for discoverability (https://github.com/woocommerce/woocommerce-admin/pull/469) 2018-09-24 11:22:14 -04:00
client Add visual component docs from markdown examples (https://github.com/woocommerce/woocommerce-admin/pull/470) 2018-09-24 11:36:35 -04:00
docs Documentation: Move topic READMEs into docs for discoverability (https://github.com/woocommerce/woocommerce-admin/pull/469) 2018-09-24 11:22:14 -04:00
images Add loading indicators, error state, and EmptyContent to the revenue report. (#347, woocommerce/woocommerce-admin#348) 2018-09-05 12:45:49 -04:00
includes Use WooCommerce's database prefi 2018-09-18 17:03:42 -03:00
languages Update woo-dash naming to new wc-admin name (https://github.com/woocommerce/woocommerce-admin/pull/183) 2018-07-10 08:48:06 -04:00
lib Add visual component docs from markdown examples (https://github.com/woocommerce/woocommerce-admin/pull/470) 2018-09-24 11:36:35 -04:00
tests Components: Export reusable components to a separate file + global (https://github.com/woocommerce/woocommerce-admin/pull/297) 2018-08-20 17:18:13 -04:00
.babelrc init for legends PR 2018-07-25 17:04:03 +02:00
.browserslistrc Add CSS autoprefixer (https://github.com/woocommerce/woocommerce-admin/pull/244) 2018-07-30 10:05:22 -04:00
.distignore Initial commit of plugin scaffold 2018-04-17 17:04:17 -04:00
.editorconfig Initial commit of plugin scaffold 2018-04-17 17:04:17 -04:00
.eslintignore Docs Project: Add documentation parser + inline documentation (https://github.com/woocommerce/woocommerce-admin/pull/336) 2018-08-31 13:27:21 -04:00
.eslintrc Add CSS naming conventions following Gutenberg’s standards (https://github.com/woocommerce/woocommerce-admin/pull/99) 2018-06-01 10:35:18 -04:00
.gitignore Sidebar: Add Tabs 2018-05-23 12:42:26 +12:00
.travis.yml Update `react-world-flags` package (https://github.com/woocommerce/woocommerce-admin/pull/230) 2018-07-19 12:30:25 -04:00
Gruntfile.js Update woo-dash naming to new wc-admin name (https://github.com/woocommerce/woocommerce-admin/pull/183) 2018-07-10 08:48:06 -04:00
README.md Docs: Remove REST API feature branch requirement. (https://github.com/woocommerce/woocommerce-admin/pull/445) 2018-09-19 10:55:44 -07:00
package-lock.json Add visual component docs from markdown examples (https://github.com/woocommerce/woocommerce-admin/pull/470) 2018-09-24 11:36:35 -04:00
package.json Add visual component docs from markdown examples (https://github.com/woocommerce/woocommerce-admin/pull/470) 2018-09-24 11:36:35 -04:00
phpcs.xml.dist Initial commit of plugin scaffold 2018-04-17 17:04:17 -04:00
phpunit.xml.dist Update woo-dash naming to new wc-admin name (https://github.com/woocommerce/woocommerce-admin/pull/183) 2018-07-10 08:48:06 -04:00
postcss.config.js IE11: fix CSS grid in Summary (https://github.com/woocommerce/woocommerce-admin/pull/353) 2018-09-06 17:11:34 +02:00
wc-admin.php Updated path to background process class. 2018-09-17 20:36:29 +02:00
webpack.config.js Add visual component docs from markdown examples (https://github.com/woocommerce/woocommerce-admin/pull/470) 2018-09-24 11:36:35 -04:00

README.md

WooCommerce Admin

This is a feature plugin for a modern, javascript-driven WooCommerce Admin experience.


⚠️ 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. We do not recommend running this on production sites.


Prerequisites

Gutenberg and WooCommerce should be installed prior to activating the WooCommerce Admin feature plugin.

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.

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
  • npm start : Build a development version, watch files for changes

There are also some helper scripts: