@shopgate/engage/README.md

Shopgate's ENGAGE library.

<p align="center">
  <a href="https://www.shopgate.com/en/solutions/engage-mobile-app/" rel="noopener" target="_blank">
    <img width="250" src="https://d2ytbdjodkazy3.cloudfront.net/wp-content/uploads/2019/01/Logo_engage.svg.gzip" alt="Shopgate Logo">
  </a>
</p>

<h1 align="center">Shopgate's ENGAGE</h1>

<div align="center">

[![Build Status](https://travis-ci.org/shopgate/pwa.svg?branch=v6.X)](https://travis-ci.org/shopgate/pwa)
[![Coverage Status](https://coveralls.io/repos/github/shopgate/pwa/badge.svg?branch=v6.X)](https://coveralls.io/github/shopgate/pwa?branch=v6.X)
[![GitHub (pre-)release](https://img.shields.io/github/release/shopgate/pwa/all.svg)](https://github.com/shopgate/pwa/releases)
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

</div>

## Installation

Shopgate's ENGAGE is available as an [npm package](https://www.npmjs.com/package/@@shopgate/engage).

Install with `npm`:

```sh
npm install @shopgate/engage
```

Install with `yarn`:

```sh
yarn add @shopgate/engage
```

## Contents

* `/cart` - Shopping Cart
* `/category` - Category
* `/checkout` - Checkout
* **`/components`** - [React.js](https://reactjs.org) components
* `/core`
  * App *(pwa app)*
  * AppCommands
  * Classes
  * Client
  * Collections
  * Contexts
  * Emitters
  * HOCs
  * Hooks *(React Hooks)*
  * Menu *(navigation)*
  * Modal
  * Providers
  * Redux Store
  * Router
  * URL *(registration, etc.)*
* `/favorites` - Favorites / Wishlist
* `/filter` - Filter (Search Result / Product List)
* `/market` - Shop Market
* `/orders` - Customer Orders
* `/page` - CMS Pages
* `/product` - Product
* `/reviews` - Product Reviews
* `/scanner` - AdScanner, BarcodeScanner, CreditCardScanner
* `/search` - Product Search
* `/user` - User

## Documentation

Check out our [documentation website](https://developer.shopgate.com/guides)!

## About Shopgate

Shopgate is the leading mobile commerce platform.

Shopgate offers everything online retailers need to be successful in mobile. Our leading
software-as-a-service (SaaS) enables online stores to easily create, maintain and optimize native
apps and mobile websites for the iPhone, iPad, Android smartphones and tablets.

## License

Shopgate's ENGAGE library is available under the Apache License, Version 2.0.

See the [LICENSE.md](./LICENSE.md) file for more information.