kitsu-client-js

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.

Documentation

Install

Installation can be done via npm:

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.

import kitsuClient from 'kitsu-client-js'

const client = kitsuClient.createClient('http://localhost:8080/api')

client.login('[e-mail]', '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 of this repository.

Feature requests

Feature requests must be posted on our Canny page.

Translations

If you want to contribute to translations, you can connect directly to the POEditor platform.

Code

All contributions are welcomed as long as they respect the C4 contract.

The Kitsu code is written with Javascript (ES6) and is based on the VueJS framework extended with the Vuex plugin.

To install the development environment, follow the dedicated guide.

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 for more information.