README.md

Kaneo

An open source project management platform focused on simplicity and efficiency.

Quick Start | Website | Demo | Discord

✨ Features

• 🚀 Simple & Fast: Minimalist interface with powerful features
• 🔒 Self-hosted: Full control over your data
• 🎨 Customizable: Make it yours with extensive customization options
• 🤝 Open Source: MIT licensed, free forever

🚀 Quick Start

1. Create a compose.yml file with the following content:

services:
  backend:
    image: ghcr.io/kaneo-app/api:latest
    environment:
      JWT_ACCESS: "change_me"
      DB_PATH: "/app/apps/api/data/kaneo.db"
    ports:
      - 1337:1337
    restart: unless-stopped
    volumes:
      - sqlite_data:/app/apps/api/data

  frontend:
    image: ghcr.io/kaneo-app/web:latest
    environment:
      KANEO_API_URL: "http://localhost:1337"
    ports:
      - 5173:80
    restart: unless-stopped

volumes:
  sqlite_data:

2. Run docker compose up -d to start the services.

3. Open http://localhost:5173 in your browser.

4. Create your first project and start managing your tasks!

Variable	Description
KANEO_API_URL	The URL of the API
JWT_ACCESS	Secret key for generating JWT tokens
DB_PATH	The path to the database file

📖 Documentation

For detailed instructions and documentation, visit our Documentation.

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

💬 Community

• Discord - Chat with the community
• GitHub Issues - Report bugs or suggest features
• Website - Official website

📝 License

This project is licensed under the MIT License.