README.md

Monorepo for WooCommerce POS

React Native cross-platform applications for taking WooCommerce orders at the Point of Sale.

About  —  Structure  —  Workflows  —  How to use it

💡 About

The goal of this project is to develop a free and extensible Point of Sale application with first-class support for collecting payment via cryptocurrency.

Currently the application requires WooCommerce to provide the backend database, but it should not necessarily be limited to WooCommerce.

This monorepo contains all the code necessary to build the client applications. To use with WooCommerce you will need to also install the WooCommerce POS plugin for WordPress.

📁 Structure

• apps - Apps that only use packages and aren't aware of other apps.
• packages - Node packages that may use external and/or local packages.

Apps

• apps/managed - Expo managed app builds for Web, iOS and Android.
• apps/electron - Builds app for Windows, MacOS and Linux.

Packages

• packages/core - Core screens and navigation.
• packages/components - Shared UI components, see playground.
• packages/form - React Native JSONSchema Form, see playground.
• packages/database - Local database (IndexedDB for Web and Desktop, SQLite for Native).
• packages/themes - Theme library.
• packages/hooks - Shared hooks.
• packages/utils - Shared utils.
• packages/babel - Babel configuration for Expo.
• packages/eslint - ESLint configuration for Expo.
• packages/tsconfig - TypeScript configuration.

👷 Workflows

Clone the monorepo repository, using the recursive flag will also clone the submodules.

> git clone --recursive https://github.com/wcpos/monorepo.git

Next install the Javascript dependencies using yarn:

> yarn install

To start the web, iOS and Android development build, use:

> yarn managed start

To start the electron (desktop) development build, use:

> yarn electron start

🚀 How to use it

Coming soon.