Skip to content

Latest commit

 

History

History
82 lines (65 loc) · 4.02 KB

README.md

File metadata and controls

82 lines (65 loc) · 4.02 KB
Raw

Kanri banner
Kanban boards done right. Made with simplicity and user experience in mind, Kanri helps you create Kanban boards easily, right from your desktop. No internet connection or account needed!

Release Version Badge GitHub Build Status
Repo license Reuse status

🚀 Demo

kanri_demo_gif

⬇️ Download

You can download Kanri for Windows, Mac and Linux at kanriapp.com, it's free!

Apple Silicon users, please run this command to prevent the error saying the app is broken:

xattr -cr /Applications/kanri.app

✨ Why Kanri?

  • 🏙 Modern - featuring a clean design & new technologies like Tauri
  • 👓 Familiar - uses a Kanban board layout
  • 🧾 Offline - saves your data in a local .json file
  • 🛠 Customizable - allows for custom themes, background images and card colors
  • ⌨ With power users in mind - implements keyboard shortcuts to speed up board navigation

📋 Roadmap

Long term vision for the project:

  • 👷‍♂️ Improve current features and refactor to avoid tech debt
  • ➕ Add additional small/mid-sized features with high impact (reminders, sub-tasks, etc.)
  • 🚚 Work towards 1.0 release with features from the backlog like internationalization or a widget panel
  • 🔍 After 1.0: Assess what direction to take (focus on offline-only features or add support for cloud sync and collaboration)

A granular list of priorities can be found in the roadmap.

This project is open for any contributions or feature requests as long as they are polite, provide enough context and remain patient (replies might take a few days).

Note

This project is still in active development and is provided "AS IS". Please make regular backups/exports to prevent any data loss.

🛠 Contributing & Build Setup

If you want to contribute, please take a look at the Contribution Guidelines. The main branch is equivalent to a dev branch where development is done on - submit PRs here. The release branch is similar to a stable branch with the code of latest release.

Build Setup: If you want to build the app, you need to install Node.js (latest LTS version recommended), a package manager like yarn and the Tauri development environment. Then, depending on your use case you can run the commands below:

# Install dependencies
yarn install

# Start debug tauri build
yarn tauri dev

# Build tauri for production
yarn generate
yarn tauri build

Copyright (c) 2022-2024 trobonox ([email protected]). Licensed under GPL v3 (with some files under Apache 2.0 or other licenses stated in the files themselves). The Kanri logo, name and other branding are NOT open source, full copyright belongs to trobonox.