Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/trobonox/kanri

๐Ÿช Modern offline Kanban board app for Windows, MacOS and Linux. Built with simplicity and user experience in mind.
https://github.com/trobonox/kanri

kanban kanban-board kanban-board-application nuxt nuxt3 nuxtjs offline offline-app offline-first offline-kanban-board tauri typescript vue3 vuejs

Last synced: 3 months ago
JSON representation

๐Ÿช Modern offline Kanban board app for Windows, MacOS and Linux. Built with simplicity and user experience in mind.

Awesome Lists containing this project

README

        


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](https://github.com/trobonox/kanri/assets/57040351/fa7a9d79-3847-47cb-8325-6715477879f4)

## โฌ‡๏ธ Download
You can download Kanri for Windows, Mac and Linux at [kanriapp.com](https://kanriapp.com), it's free!

Apple Silicon users, please run this command to prevent the error saying the app is broken:
```bash
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: 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](https://github.com/trobonox/kanri/projects).

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.

> [!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](https://github.com/trobonox/kanri/blob/main/CONTRIBUTING.md).
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](https://tauri.app/v1/guides/getting-started/prerequisites).
Then, depending on your use case you can run the commands below:

```bash
# 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.