woocommerce/plugins/woocommerce-admin/docs
Kelly Dwan cd58cc78ac Build: Update packages (https://github.com/woocommerce/woocommerce-admin/pull/434)
* Update packages to latest versions

* Update snapshot to match updated jest format

* Add missing packages

* Pin docsify-cli to GitHub commit with security fix

* Update engines settings

* Update packages

Again, some things are already out of date from last week

* Regenerate docs
2018-09-18 17:37:57 -04:00
..
components Build: Update packages (https://github.com/woocommerce/woocommerce-admin/pull/434) 2018-09-18 17:37:57 -04:00
.nojekyll Docs Project: Add markdown files, docsify to render site (https://github.com/woocommerce/woocommerce-admin/pull/337) 2018-08-31 16:13:20 -04:00
README.md Docs Project: Add markdown files, docsify to render site (https://github.com/woocommerce/woocommerce-admin/pull/337) 2018-08-31 16:13:20 -04:00
_sidebar.md Build: Update packages (https://github.com/woocommerce/woocommerce-admin/pull/434) 2018-09-18 17:37:57 -04:00
index.html Docs Project: Add markdown files, docsify to render site (https://github.com/woocommerce/woocommerce-admin/pull/337) 2018-08-31 16:13:20 -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. You also need v3 of the WooCommerce REST API, which you can get by installing the feature branch of WooCommerce. Clone the feature branch from github, or download a zip of WooCommerce.

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: