talissonf / ecomplus-client

JS client for E-Com Plus REST APIs

ecomplus-client

JS client for E-Com Plus REST APIs

Changelog

Usage

TL;DR: We have methods to run requests for almost all E-Com Plus APIs, but you're probably searching for Store API.

The @ecomplus/client package provides a list of methods, each one is a function to request a specific E-Com Plus REST API, using axios HTTP client and returning a Promise.

It's available for both Node.js and browser environments.

• Get started
• Methods

Dependencies

It requires and doesn't include axios and @ecomplus/utils.

It'll be automatically imported if you're developing on Node.js environment or using a bundler such as Webpack, in other case those libraries must be included manually on window scope.

Development

We're using Conventional Commits, all commit messages must follow these conventions.

For documentation, we're using jsdoc, all methods should be well documented.

Contributing

1. Fork the repository;

2. Create a new branch with the name of your proposal;

3. Clone the repository:

git clone [e-mail]:{user}/ecomplus-client.git

5. Move to folder and install dependencies:

cd ecomplus-client
npm i

6. Run dev server and use global ecomClient or edit test/demo.js for tests on http://localhost:9245/:

npm run serve

7. Commit changes following Conventional Commits;

8. Create a new PR describing your proposal :)

Deploy

Take a look on package.json scripts:

• npm run doc - Update jsdoc/docdash generated documentation;
• npm run release - Generate changelog and new version;