https://github.com/usekaneo/kaneo

An open source project management platform focused on simplicity and efficiency. Self-host it, customize it, make it yours. 🚀
https://github.com/usekaneo/kaneo

elysiajs kanban project-management react self-hosted typescript

Last synced: about 2 months ago
JSON representation

An open source project management platform focused on simplicity and efficiency. Self-host it, customize it, make it yours. 🚀

• Host: GitHub
• URL: https://github.com/usekaneo/kaneo
• Owner: usekaneo
• License: mit
• Created: 2024-12-31T08:25:09.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-03-15T17:46:33.000Z (2 months ago)
• Last Synced: 2025-03-15T18:30:51.286Z (2 months ago)
• Topics: elysiajs, kanban, project-management, react, self-hosted, typescript
• Language: TypeScript
• Homepage: https://kaneo.app
• Size: 3.03 MB
• Stars: 1,027
• Watchers: 8
• Forks: 62
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - usekaneo/kaneo - An open source project management platform focused on simplicity and efficiency. Self-host it, customize it, make it yours. 🚀 (TypeScript)

README

        


  

    

  



Kaneo




[![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/usekaneo/kaneo/ci.yml?branch=main)](https://github.com/usekaneo/kaneo/actions)

[![Discord](https://img.shields.io/discord/1326250681530843178?color=7389D8&label=&logo=discord&logoColor=ffffff)](https://discord.gg/rU4tSyhXXU)



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:

```yaml

services:

  backend:

    image: ghcr.io/usekaneo/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/usekaneo/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](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](https://kaneo.app/quick-start).

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

## 💬 Community

- [Discord](https://discord.gg/rU4tSyhXXU) - Chat with the community

- [GitHub Issues](https://github.com/usekaneo/kaneo/issues) - Report bugs or suggest features

- [Website](https://kaneo.app) - Official website

## 📝 License

This project is licensed under the [MIT License](LICENSE).