Skip to content
/ kanri Public
forked from trobonox/kanri

🪐 Trello-inspired offline Kanban board app for Windows, MacOS and Linux. Built with simplicity and UX in mind.

License

Notifications You must be signed in to change notification settings

x0f5c3/kanri

 
 

Repository files navigation

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!

GitHub Build Status
Repo license Reuse status
Discord Status Release Version Badge

Screenshot of a fully customized version of the app, in the main Kanban board view: kanri_customized

You can download it for free for Windows, Mac and Linux from the GitHub releases!

✨ Why Kanri?

  • 🏙 Modern - featuring a clean design & new technologies like Tauri
  • 👓 Familiar - uses a Kanban board layout (inspired by Trello®)
  • 🧾 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

Note: This is a fairly early and untested version, it is advised to make regular JSON exports. Any testers that provide feedback are greatly appreciated.

📋 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: Possibility of cloud sync with collaboration (could be self-hosted or managed by me)

A granular list of priorities can be found in the roadmap in the projects tab of this GitHub repo.

This project is open for any contributions or feature requests, though always keep in mind that I am still a student with limited time and I might not be able to process every request immediately.

🛠 Contributing & Build Setup

If you want to contribute, please take a look at the Contribution Guidelines.

Build Setup: If you want to build the app, you need to install Node.js (v16 LTS is 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-2023 trobonox ([email protected]). Licensed under the Apache 2.0 License.

Background image used in the showcase screenshot made by Richard Horvath on Unsplash.

About

🪐 Trello-inspired offline Kanban board app for Windows, MacOS and Linux. Built with simplicity and UX in mind.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Vue 98.5%
  • Other 1.5%