kaneo (minimalist kanban) fork to experiment adding a tangled integration
github.com/usekaneo/kaneo
1<p align="center">
2 <a href="https://kaneo.app">
3 <img src="https://assets.kaneo.app/logo-text.png" alt="Kaneo's logo" width="300" />
4 </a>
5</p>
6
7<div align="center">
8
9[](LICENSE)
10[](https://github.com/usekaneo/kaneo/actions)
11[](https://discord.gg/rU4tSyhXXU)
12[](https://github.com/sponsors/andrejsshell)
13
14</div>
15
16<div align="center">
17 <h3>
18 <a href="https://kaneo.app/docs/core">Quick Start</a>
19 <span> | </span>
20 <a href="https://kaneo.app">Website</a>
21 <span> | </span>
22 <a href="https://cloud.kaneo.app">Cloud (free)</a>
23 <span> | </span>
24 <a href="https://discord.gg/rU4tSyhXXU">Discord</a>
25 </h3>
26</div>
27
28
29<p align="center">
30 <img src="https://assets.kaneo.app/readme.png" alt="Kaneo Dashboard" />
31</p>
32
33## Why Kaneo?
34
35After years of using bloated, overcomplicated project management platforms that distracted from actual work, we built Kaneo to be different.
36
37The problem with most tools isn't that they lack features—it's that they have **too many**. Every notification, every unnecessary button, every complex workflow pulls your team away from what matters: **building great products**.
38
39We believe the best tools are **invisible**. They should amplify your team's natural workflow, not force you to adapt to theirs. Kaneo is built on the principle that **less is more**—every feature exists because it solves a real problem, not because it looks impressive in a demo.
40
41**What makes it different:**
42- **Clean interface** that focuses on your work, not the tool
43- **Self-hosted** so your data stays yours
44- **Actually fast** because we care about performance
45- **Open source** and free forever
46
47Learn more about Kaneo's features and capabilities in our [documentation](https://kaneo.app/docs/core).
48
49## Sponsors
50
51Kaneo is open source and free forever. If you find it useful, consider [sponsoring the project](https://github.com/sponsors/andrejsshell) to help support ongoing development.
52
53## Getting Started
54
55### One-Click Deployment with drim
56
57For straightforward deployments, use [drim](https://github.com/usekaneo/drim) - a CLI tool that handles everything for you:
58
59```bash
60curl -fsSL https://assets.kaneo.app/install.sh | sh
61drim setup
62```
63
64That's it. Your Kaneo instance will be running with automatic HTTPS, database setup, and all services configured.
65
66Perfect for quick deployments and production setups where you want things to just work.
67
68### Quick Start with Docker Compose
69
70The fastest way to try Kaneo is with Docker Compose. This sets up the API, web interface, and PostgreSQL database:
71
72```yaml
73services:
74 postgres:
75 image: postgres:16-alpine
76 env_file:
77 - .env
78 ports:
79 - "5432:5432"
80 volumes:
81 - postgres_data:/var/lib/postgresql/data
82 restart: unless-stopped
83 healthcheck:
84 test: ["CMD-SHELL", "pg_isready -U kaneo -d kaneo"]
85 interval: 10s
86 timeout: 5s
87 retries: 5
88
89 api:
90 image: ghcr.io/usekaneo/api:latest
91 ports:
92 - "1337:1337"
93 env_file:
94 - .env
95 depends_on:
96 postgres:
97 condition: service_healthy
98 restart: unless-stopped
99
100 web:
101 image: ghcr.io/usekaneo/web:latest
102 ports:
103 - "5173:5173"
104 env_file:
105 - .env
106 depends_on:
107 - api
108 restart: unless-stopped
109
110volumes:
111 postgres_data:
112```
113
114Save this as `compose.yml`, create a `.env` file with your configuration (see the [documentation](https://kaneo.app/docs/core) for all required environment variables), run `docker compose up -d`, and open [http://localhost:5173](http://localhost:5173).
115
116> **Important:** See our [full documentation](https://kaneo.app/docs/core) for detailed setup instructions, environment variable configuration, and troubleshooting guides.
117
118### Development Setup
119
120For development, see our [Environment Setup Guide](ENVIRONMENT_SETUP.md) for detailed instructions on configuring environment variables and troubleshooting common issues like CORS problems.
121
122### Configuration
123
124Kaneo requires several environment variables to be configured. The Docker Compose setup above handles the database automatically, but you'll need to configure environment variables for the API and web services.
125
126For complete configuration instructions, including all required environment variables, database setup for non-Docker deployments, and advanced settings, see the [documentation](https://kaneo.app/docs/core).
127
128## Kubernetes Deployment
129
130If you're running Kubernetes, we provide a comprehensive Helm chart. Check out the [Helm chart documentation](./charts/kaneo/README.md) for detailed installation instructions, production configuration examples, TLS setup, and more.
131
132## Development
133
134Want to hack on Kaneo? See our [Environment Setup Guide](ENVIRONMENT_SETUP.md) for detailed instructions on configuring environment variables and troubleshooting common issues like CORS problems.
135
136Quick start:
137```bash
138# Clone and install dependencies
139git clone https://github.com/usekaneo/kaneo.git
140cd kaneo
141pnpm install
142
143# Create a .env file in the root with required environment variables
144# See ENVIRONMENT_SETUP.md for detailed instructions
145
146# Start development servers
147pnpm dev
148```
149
150For contributing guidelines, code structure, and development best practices, check out our [contributing guide](CONTRIBUTING.md) and [documentation](https://kaneo.app/docs/core).
151
152## Community
153
154- **[Discord](https://discord.gg/rU4tSyhXXU)** - Chat with users and contributors
155- **[GitHub Issues](https://github.com/usekaneo/kaneo/issues)** - Bug reports and feature requests
156- **[Documentation](https://kaneo.app/docs/core)** - Detailed guides, API docs, and tutorials
157
158## Contributing
159
160We're always looking for help, whether that's:
161- Reporting bugs or suggesting features
162- Improving documentation
163- Contributing code
164- Helping other users on Discord
165
166Check out [CONTRIBUTING.md](CONTRIBUTING.md) for the details on how to get involved.
167
168## License
169
170MIT License - see [LICENSE](LICENSE) for details.
171
172---
173
174<div align="center">
175 <img src="https://repobeats.axiom.co/api/embed/3e8367ec2b2350e4fc48662df33c81dac657b833.svg" alt="Repobeats analytics image" />
176</div>
177
178<p align="center">
179 Built with ❤️ by the Kaneo team and <a href="#contributors">contributors</a>
180</p>