diff options
| -rw-r--r-- | README.md | 41 | ||||
| -rw-r--r-- | doc/api-examples.markdown | 56 | ||||
| -rw-r--r-- | doc/faq.markdown | 34 |
3 files changed, 41 insertions, 90 deletions
@@ -5,7 +5,7 @@ Kanboard [](https://scrutinizer-ci.com/g/fguillot/kanboard/) [](https://insight.sensiolabs.com/projects/5e50750e-fc62-4a1f-b02a-71991123a2a7) -Kanboard is a project management software that uses the Kanban methodology. +Kanboard is a project management software that focus on the Kanban methodology. Official website: <http://kanboard.net> @@ -13,38 +13,23 @@ Official website: <http://kanboard.net> - Multiple boards with the ability to drag and drop tasks - Open source and self-hosted - Super simple installation -- Translated in 24 languages -- Distributed under [MIT License](LICENSE) -- [List of features are available on the website](http://kanboard.net/features) -- [Change Log](ChangeLog) +- Translated in many languages +- Distributed under [MIT License](https://github.com/fguillot/kanboard/blob/master/LICENSE) +- The complete [list of features are available on the website](http://kanboard.net/features) +- [Change Log](https://github.com/fguillot/kanboard/blob/master/ChangeLog) +- [Documentation](https://github.com/fguillot/kanboard/blob/master/doc/index.markdown) [](https://heroku.com/deploy) -Known bugs and feature requests -------------------------------- - -- Bug tracker: <https://github.com/fguillot/kanboard/issues> - Authors ------- -- Main developer: Frédéric Guillot (fguillot) -- [List of contributors](CONTRIBUTORS.md) - -Documentation -------------- - -- [Read the documentation](doc/index.markdown) - -Related projects ----------------- +- Main developer: [Frédéric Guillot](https://github.com/fguillot) +- [List of contributors](https://github.com/fguillot/kanboard/blob/master/CONTRIBUTORS.md) -List of plugins: http://kanboard.net/plugins +Installation and Upgrade +------------------------ -- [Kanboard API python client by @freekoder](https://github.com/freekoder/kanboard-py) -- [Kanboard Presenter by David Eberlein](https://github.com/davideberlein/kanboard-presenter) -- [CSV2Kanboard by @ashbike](https://github.com/ashbike/csv2kanboard) -- [Kanboard for Yunohost by @mbugeia](https://github.com/mbugeia/kanboard_ynh) -- [Trello import script by @matueranet](https://github.com/matueranet/kanboard-import-trello) -- [Chrome extension by Timo](https://chrome.google.com/webstore/detail/kanboard-quickmenu/akjbeplnnihghabpgcfmfhfmifjljneh?utm_source=chrome-ntp-icon), [Source code](https://github.com/BlueTeck/kanboard_chrome_extension) -- [Python client script by @dzudek](https://gist.github.com/fguillot/84c70d4928eb1e0cb374) +- [Requirements](http://kanboard.net/documentation/requirements) +- [Installation instructions](http://kanboard.net/documentation/installation) +- [Upgrade to a new version](http://kanboard.net/documentation/update) diff --git a/doc/api-examples.markdown b/doc/api-examples.markdown index 9b1ed12a..14d5db98 100644 --- a/doc/api-examples.markdown +++ b/doc/api-examples.markdown @@ -34,62 +34,30 @@ Response from the server: Example with Python ------------------- -Here a basic example written in Python to create a task: +You can use the [official Python client for Kanboard](https://github.com/kanboard/kanboard-api-python): -```python -#!/usr/bin/env python - -import requests -import json - -def main(): - url = "http://demo.kanboard.net/jsonrpc.php" - api_key = "be4271664ca8169d32af49d8e1ec854edb0290bc3588a2e356275eab9505" - headers = {"content-type": "application/json"} - - payload = { - "method": "createTask", - "params": { - "title": "Python API test", - "project_id": 1 - }, - "jsonrpc": "2.0", - "id": 1, - } +```bash +pip install kanboard +``` - response = requests.post( - url, - data=json.dumps(payload), - headers=headers, - auth=("jsonrpc", api_key) - ) +Here an example to create a project and a task: - if response.status_code == 401: - print "Authentication failed" - else: - result = response.json() +```python +from kanboard import Kanboard - assert result["result"] == True - assert result["jsonrpc"] - assert result["id"] == 1 +kb = Kanboard("http://localhost/jsonrpc.php", "jsonrpc", "your_api_token") - print "Task created successfully!" +project_id = kb.create_project(name="My project") -if __name__ == "__main__": - main() +task_id = kb.create_task(project_id=project_id, title="My task title") ``` -Run this script from your terminal: - -```bash -python jsonrpc.py -Task created successfully! -``` +There are more examples on the [official website](https://github.com/kanboard/kanboard-api-python). Example with a PHP client ------------------------- -I wrote a simple [Json-RPC Client/Server library in PHP](https://github.com/fguillot/JsonRPC), here an example: +You can use this [Json-RPC Client/Server library for PHP](https://github.com/fguillot/JsonRPC), here an example: ```php <?php diff --git a/doc/faq.markdown b/doc/faq.markdown index de7c9801..953f98e1 100644 --- a/doc/faq.markdown +++ b/doc/faq.markdown @@ -10,18 +10,18 @@ Kanboard works well with any great VPS hosting provider such as [Digital Ocean]( To have the best performances, choose a provider with fast disk I/O because Kanboard use Sqlite by default. Avoid hosting providers that use a shared NFS mount point. + I get a blank page after installing or upgrading Kanboard --------------------------------------------------------- - Check if you have installed all requirements on your server +- Check the PHP and Apache error logs - Check if the files have the correct permission -- If you use php-fpm and opcode caching, reload the process to be sure to clear the cache -- Enable PHP error logging in your php.ini -- Check the PHP and Apache error logs you should see the exact error +- If you use an aggressive OPcode caching, reload your web-server or php-fpm Page not found and the URL seems wrong (&amp;) ----------------------------------------------- +-------------------------------------------------- - The URL looks like `/?controller=auth&action=login&redirect_query=` instead of `?controller=auth&action=login&redirect_query=` - Kanboard returns a "Page not found" error @@ -85,20 +85,6 @@ open http://localhost:8000/ ``` -How to migrate my tasks from Wunderlist? ----------------------------------------- - -You can use an external tool to import your tasks automatically and lists from Wunderlist to Kanboard. - -This is a command line script made by a contributor of Kanboard. -It's simple, quick and dirty but it works :) - -More information here: - -- [Wunderlist](http://www.wunderlist.com/) -- <https://github.com/EpocDotFr/WunderlistToKanboard> - - How to install Kanboard on Yunohost? ------------------------------------ @@ -107,6 +93,18 @@ How to install Kanboard on Yunohost? There is a [package to install Kanboard on Yunohost easily](https://github.com/mbugeia/kanboard_ynh). +Where can I find a list of related projects? +-------------------------------------------- + +- [Kanboard API python client by @freekoder](https://github.com/freekoder/kanboard-py) +- [Kanboard Presenter by David Eberlein](https://github.com/davideberlein/kanboard-presenter) +- [CSV2Kanboard by @ashbike](https://github.com/ashbike/csv2kanboard) +- [Kanboard for Yunohost by @mbugeia](https://github.com/mbugeia/kanboard_ynh) +- [Trello import script by @matueranet](https://github.com/matueranet/kanboard-import-trello) +- [Chrome extension by Timo](https://chrome.google.com/webstore/detail/kanboard-quickmenu/akjbeplnnihghabpgcfmfhfmifjljneh?utm_source=chrome-ntp-icon), [Source code](https://github.com/BlueTeck/kanboard_chrome_extension) +- [Python client script by @dzudek](https://gist.github.com/fguillot/84c70d4928eb1e0cb374) + + Are there some tutorials about Kanboard in other languages? ----------------------------------------------------------- |