Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cgwire/kitsu-client-js
https://github.com/cgwire/kitsu-client-js
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cgwire/kitsu-client-js
- Owner: cgwire
- License: lgpl-3.0
- Created: 2021-12-06T10:47:17.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-26T17:54:39.000Z (about 2 years ago)
- Last Synced: 2024-05-01T11:43:02.147Z (5 months ago)
- Language: JavaScript
- Size: 438 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://kitsu.cg-wire.com)
# Javascript client for Kitsu
This is a library to ease your life while connecting your javascript code to
Kitsu, the collaboration platform for animation studios.
[](https://app.travis-ci.com/cgwire/kitsu-client-js)
[](https://discord.com/invite/VbCxtKN)
## Documentation
### Install
Installation can be done via npm:
```bash
npm i kitsu-client-js
```
### Usage
There is no specification avaialable at the moment. We invite you to browse the
code for checking if a function exists. You can propose yours too and submit it
via a pull request.
```javascript
import kitsuClient from 'kitsu-client-js'
const client = kitsuClient.createClient('http://localhost:8080/api')
client.login('[email protected]', 'password')
.then(client.getOpenProductions)
.then(productions => {
console.log(productions)
})
```
## Contributing
As any open source project, we enjoy any contribution! You will find below
how you can help the Kitsu project to get better.
### Bug reports
All bugs must be submitted directly in
[the issue page](https://github.com/cgwire/kitsu-client-js/issues) of this repository.
### Feature requests
Feature requests must be posted on our [Canny page](https://cgwire.canny.io/).
### Translations
If you want to contribute to translations, you can connect directly to the
[POEditor platform](https://poeditor.com/join/project?hash=fpUejpWDVo).
### Code
All contributions are welcomed as long as they respect the [C4
contract](https://rfc.zeromq.org/spec:42/C4).
The Kitsu code is written with Javascript (ES6) and is based on the
[VueJS](https://vuejs.org/v2/guide/) framework extended with
the [Vuex](https://vuex.vuejs.org) plugin.
To install the development environment, follow [the dedicated guide](https://kitsu.cg-wire.com/development-environment/).
## About authors
Kitsu is written by CGWire, a company based in France. We help teams of animation
studios to collaborate better. We provide tools to more than 50 studios spread
all around the world.
On the technical side, we apply software craftmanship principles as much as
possible. We love coding and consider that strong quality and good developer
experience matter a lot.
Visit [cg-wire.com](https://cg-wire.com) for more information.
[](https://cg-wire.com)