@listo-paye/sdk-core v1.0.0-rc.2

Getting Started

Prerequisites

Node.js > v16.x

Installation

yarn add @listo-paye/sdk-core

Usage

Full documentation is available here.

Initiate the SDK

init({
   sponsorCredentials: {
      email: 'john@appleseed.com',
      password: '*************************'
   },
   etablissementId: '0516b63c-6e12-4a2c-a0f3-23302e06fdd3'
})

Load transfer data from Listo Paye

loadTransferData({ date: '2020-07-01' })

Start a transfer

initiateTransfer()

Contributing

The Stack

• TypeScript: The programming language for frontend.
• TSdx: Zero-config CLI for TypeScript package development.

Development

• ESLint & Prettier: Code-quality & Formatting.
• Husky: Git Hook.

Installation

1. Clone the repository

   git clone git@gitlab.com:listopro/virements-salaires.git

2. Setup Node.js.

   cd virements-salaires && \
   nvm use

3. Install the dependencies

   yarn

Develop

Run the development server:

yarn run sdk-core:develop

Open http://localhost:6006 with your browser to see the Storybook.

To run the unit tests for the SDK Core, run:

yarn run sdk-core:test:watch

Release

yarn run sdk-core:release

You can pass any other arguments to the underneath publish command:

yarn run sdk-core:release -- --tag rc