woocommerce/plugins/woocommerce-admin/docs/README.md

# WooCommerce Admin

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

---

: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.**

---

## Prerequisites

[Gutenberg](https://wordpress.org/plugins/gutenberg/) and [WooCommerce](https://wordpress.org/plugins/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:

 - `npm run lint` : Run eslint over the javascript files
 - `npm run i18n` : Create a PHP file with the strings from the javascript files, [used to get around lack of JS support in WordPress.org](https://github.com/WordPress/packages/tree/master/packages/i18n#build).
Docs Project: Add markdown files, docsify to render site (https://github.com/woocommerce/woocommerce-admin/pull/337) * Add generated docs to repo, add command to regenerate docs * Add docsify to render markdown files & search from GitHub.io * Add prop type description if it exists This property is only filled in on descendent proptypes (items in a shape, for example) * Vaguely woo-themed * Tweak spacing in markdown file, add final newline to each file 2018-08-31 20:13:20 +00:00			`# WooCommerce Admin`

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

			`---`

			`: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.`

			`---`

			`## 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.`
Docs Project: Add markdown files, docsify to render site (https://github.com/woocommerce/woocommerce-admin/pull/337) * Add generated docs to repo, add command to regenerate docs * Add docsify to render markdown files & search from GitHub.io * Add prop type description if it exists This property is only filled in on descendent proptypes (items in a shape, for example) * Vaguely woo-themed * Tweak spacing in markdown file, add final newline to each file 2018-08-31 20:13:20 +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.

			`## 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:`

			- `npm run lint` : Run eslint over the javascript files
			- `npm run i18n` : Create a PHP file with the strings from the javascript files, [used to get around lack of JS support in WordPress.org](https://github.com/WordPress/packages/tree/master/packages/i18n#build).