woocommerce/plugins/woocommerce-admin/README.md

# WooCommerce Dashboard

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

## Prerequisites

[Gutenberg](https://wordpress.org/plugins/gutenberg/) and [WooCommerce](https://wordpress.org/plugins/woocommerce/) should be installed prior to activating the WooCommerce Dashboard feature plugin.

## 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 run dev` : Build a development version
 - `npm run watch` : 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).
Add an admin page, build a simple component + filters 2018-04-17 23:51:48 +00:00			`# WooCommerce Dashboard`

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

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`

			`[Gutenberg](https://wordpress.org/plugins/gutenberg/) and [WooCommerce](https://wordpress.org/plugins/woocommerce/) should be installed prior to activating the WooCommerce Dashboard feature plugin.`

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
			- `npm run dev` : Build a development version
			- `npm run watch` : 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).