https://github.com/joblocal/api-client
https://github.com/joblocal/api-client
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/joblocal/api-client
- Owner: joblocal
- Created: 2019-04-03T15:14:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-11T08:47:01.000Z (over 1 year ago)
- Last Synced: 2024-03-27T12:12:21.342Z (about 1 year ago)
- Language: JavaScript
- Size: 1.49 MB
- Stars: 5
- Watchers: 8
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
Awesome Lists containing this project
README
# Joblocal Api-Client
This v4 API is deprecated! Please use the v5 client instead: https://github.com/joblocal/api-client-v5
This package contains a pre-configured devour-client for the Joblocal api
[Devour](https://github.com/twg/devour) - Api client for JSON-Api-Specification compliant resource handling
[Documentation]('https://joblocal.api-docs.io/') - Api Documentation
## Requirements
- Yarn or npm
## Installation
Using yarn:
```sh
$ yarn add @joblocal/api-client
```
Using npm:
```sh
$ npm install --save @joblocal/api-client
```
## Usage
After installing the package you can use it as follows.
```javascript
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:**
```sh
$ yarn install
```
**Verify by running tests:**
```sh
$ yarn test
```
## Built with
* [Devour](https://github.com/twg/devour) - Api client for JSON-Api-Specification compliant resource handling
* [Yarn](https://yarnpkg.com/lang/en/) - Dependency Management
* [Webpack](https://webpack.js.org/) - Application Bundler
* [Jest](https://facebook.github.io/jest/) - Test Runner
### Also see
* [Jest Api](https://facebook.github.io/jest/docs/en/api.html)
## Contributing
Please read through our [contributing guidelines](https://github.com/joblocal/api-client/blob/master/contributing.md). Included are directions for opening issues, coding standards, and feature requests.
## Authors
* **Joblocal GmbH** - *Initial work* - [Joblocal](https://github.com/joblocal)
See also the list of [contributors](https://github.com/joblocal/api-client/contributors) who participated in this project.