🏪 A simple front-end for taking WooCommerce orders at the Point of Sale.
JavaScript PHP CSS Other
Latest commit 545da92 Jan 8, 2017 @kilbot update settings

README.md

WooCommerce POS

Build Status Code Climate Coverage Status Dependency Status Join the chat at https://gitter.im/kilbot/WooCommerce-POS

Development repository for WooCommerce POS - the Point of Sale plugin for WooCommerce.

Screenshot

Browser Compatibility

Browser Compatibility

[![Selenium Test Status](https://saucelabs.com/browser-matrix/wcpos.svg)](https://saucelabs.com/u/wcpos)

Report a bug

Please report all bugs here or contact support via support@wcpos.com

Translations

If you would like to help translate WooCommerce POS into your language please check out the WooCommerce POS Language Packs repository.

Developing locally

WooCommerce POS is a WordPress plugin which requires WordPress 3.8+ and WooCommerce 2.2+.

This project includes configuration files for creating a consistent development environment for WooCommerce plugins.

Requirements

  • Docker - download Docker for Mac, Windows or Linux
  • Node

Docker provides a virtual local server with WordPress and WooCommerce pre-installed. Node provides a package manager which simplifies tasks such as building and deploying the project.

Installation

Navigate to your local projects directory and clone the project. The recursive flag will init and update any submodules.

git clone --recursive https://github.com/kilbot/WooCommerce-POS.git woocommerce-pos

Then, navigate into the root directory of the project and install the dependencies.

cd woocommerce-pos && npm run build

Now, get a coffee ☕️

The first build will take some time as it prepares the virtual server. While waiting for the first build to complete, add the following domains to your /etc/hosts file.

# /etc/hosts
127.0.0.1   php54.local
127.0.0.1   php55.local
127.0.0.1   php56.local
127.0.0.1   php70.local

Once the build is complete you can start the virtual server using:

npm run start

Open your browser and navigate to http://php56.local, you should see a WordPress + WooCommerce + WooCommerce POS site running on PHP 5.6.x. Login with admin/password to access the WordPress admin.

Developing and Deploying

The package.json file contains some helpful commands for common tasks.

When developing you should use the following command, this will watch the asset files and rebuild if necessary.

npm run dev

To create a minified version of the project ready to deploy, use:

npm run deploy

This will create a zip archive of the plugin which you can then install via your WordPress admin.

We are hiring!

We are looking for talented PHP and JS developers to work full or part time on WooCommerce POS. To apply simply submit a pull request.