Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 1.93 KB

readme.md

File metadata and controls

66 lines (49 loc) · 1.93 KB
Raw

Joblocal Api-Client

This v4 API is deprecated! Please use the v5 client instead: https://github.com/joblocal/api-client-v5

Downloads Size Zipped Size

This package contains a pre-configured devour-client for the Joblocal api Devour - Api client for JSON-Api-Specification compliant resource handling Documentation - Api Documentation

Requirements

  • Yarn or npm

Installation

Using yarn:

$ yarn add @joblocal/api-client

Using npm:

$ npm install --save @joblocal/api-client

Usage

After installing the package you can use it as follows.

import createClient from '@joblocal/api-client';

const client = createClient({
  url: 'https://api.joblocal.de/v4',
  token: 'user_id_token' || () => 'id_token' || null,
});

Development

Installing dependencies:

$ yarn install

Verify by running tests:

$ yarn test

Built with

  • Devour - Api client for JSON-Api-Specification compliant resource handling
  • Yarn - Dependency Management
  • Webpack - Application Bundler
  • Jest - Test Runner

Also see

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and feature requests.

Authors

  • Joblocal GmbH - Initial work - Joblocal

See also the list of contributors who participated in this project.