An open API service indexing awesome lists of open source software.

https://github.com/viur-framework/viur-shop-client

ViUR Shop JS Client
https://github.com/viur-framework/viur-shop-client

js-client viur viur-shop

Last synced: 4 months ago
JSON representation

ViUR Shop JS Client

Awesome Lists containing this project

README

          


ViUR Shop JS Client



Badge showing GitHub pages documentation build


Badge showing current NPM version


Badge displaying the license



On the way to becoming a JS Client for the ViUR shop backend plugin.

## Usage

```javascript
// Client use

const sc = new ViURShopClient();

sc.cart_list()
.then(payload => {
for (let root_node of payload) {
console.debug(root_node);
// [...]
}
});
```

## Installation
Download node at [nodejs.org](https://nodejs.org) and install it, if you haven't already.

```sh
npm install @viur/viur-shop-client --save
```

This package is provided in these module formats:

- CommonJS

## Documentation

You can find the documentation at [viur-framework.github.io/viur-shop-client](https://viur-framework.github.io/viur-shop-client/) (WIP).
We're following [JSDoc](https://jsdoc.app/).

## License
[MIT](LICENSE)