README.md

Linx Impulse Wishlist Javascript SDK

SDK to build frontend Web Applications for Linx Impulse Wishlist.

Getting started

Installation

To install the Wishlist SDK just run:

npm install @linx-impulse/engage-wishlist-sdk-js

Usage

After installing the SDK you can use any of the modules by including them in your code

Example:

import { Likes } from '@linx-impulse/engage-wishlist-sdk-js'

Project Strucutre

This repository is divided into three main modules:

Items

Responsible for operations that center around items (which currently is just fetching the like frequency).

Likes

Contains all functions that are used for the default 'Likes' workflow, which are the main way to interact with the API.

Lists

Contains functions that manipulates custom lists.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request

Documentation

Run doc command to generate docs:

  npx run doc

Lint

Run lint command:

  npx run lint [--fix]

Options:

• fix: automatically fixes errors found.

Testing

Run lint command:

  npx run test [--watch]

Options:

• watch: Run tests in a watch mode

Release

Run release command:

npx run release

Changelog

CHANGELOG