https://github.com/kanboard/javascript-api-client
[NOT MAINTAINED] Javascript API client for Kanboard
https://github.com/kanboard/javascript-api-client
Last synced: about 1 month ago
JSON representation
[NOT MAINTAINED] Javascript API client for Kanboard
- Host: GitHub
- URL: https://github.com/kanboard/javascript-api-client
- Owner: kanboard
- License: mit
- Archived: true
- Created: 2017-01-29T21:33:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-19T19:20:05.000Z (almost 7 years ago)
- Last Synced: 2025-03-29T01:01:30.818Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 9
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - kanboard/javascript-api-client - [NOT MAINTAINED] Javascript API client for Kanboard (others)
README
Javascript API Client for Kanboard
==================================
[Kanboard](https://kanboard.org/) is a Kanban project management software.
- Author: Frédéric Guillot
- License: MIT
Requirements
------------
- Tested with nodejs >= 7.3.x
Installation
------------
```bash
npm install kanboard
```
Examples
--------
Methods and arguments are the same as the API procedures described in the [official documentation](https://docs.kanboard.org/en/1.2.2/api/index.html).
### Get list of projects
```javascript
const Kanboard = require('kanboard');
var kb = new Kanboard('http://localhost/jsonrpc.php', 'username', 'password');
kb.execute('getMyProjects')
.on('success', (result) => {
console.log(result);
})
.on('error', (error) => {
console.log(error);
});
```
### Create a new project
```javascript
kb.execute('getMyProjects', {name: 'My project'});
```
### Create a new task
```javascript
kb.execute('createTask', {title: 'My task', project_id: 3, color_id: 'blue'});
```