README.md
Rama main · réplica de lectura del repositorio original.
<div align="center">
<h3 align="center">Kan</h3>
<p>The open-source project management alternative to Trello.</p>
</div>
<p align="center">
<a href="https://kan.bn/kan/roadmap">Roadmap</a>
·
<a href="https://kan.bn">Website</a>
·
<a href="https://docs.kan.bn">Docs</a>
·
<a href="https://github.com/kanbn/kan/discussions">Discussions</a>
</p>
<div align="center">
<a href="https://github.com/kanbn/kan/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-AGPLv3-purple"></a>
</div>
## Features
- **Board Visibility**: Control who can view and edit your boards
- **Workspace Members**: Invite members and collaborate with your team
- **Trello Imports**: Easily import your Trello boards
- **Labels & Filters**: Organise and find cards quickly
- **Comments**: Discuss and collaborate with your team
- **Activity Log**: Track all card changes with detailed activity history
- **Templates**: Save time with reusable custom board templates
- **Integrations (coming soon)**: Connect your favourite tools
See our [roadmap](https://kan.bn/kan/roadmap) for upcoming features.
## Screenshot
<img width="1507" alt="hero-dark" src="https://github.com/user-attachments/assets/8490104a-cd5d-49de-afc2-152fd8a93119" />
## Made With
- [Next.js](https://nextjs.org/?ref=kan.bn)
- [tRPC](https://trpc.io/?ref=kan.bn)
- [Better Auth](https://better-auth.com/?ref=kan.bn)
- [Tailwind CSS](https://tailwindcss.com/?ref=kan.bn)
- [Drizzle ORM](https://orm.drizzle.team/?ref=kan.bn)
- [React Email](https://react.email/?ref=kan.bn)
## Self Hosting
### One-click Deployments
The easiest way to deploy Kan is through Railway. We've partnered with Railway to maintain an official template that supports the development of the project.
<a href="https://railway.com/deploy/kan?referralCode=bZPsr2&utm_medium=integration&utm_source=template&utm_campaign=generic">
<img src="https://railway.app/button.svg" alt="Deploy on Railway" height="40" />
</a>
### Docker Compose
Alternatively, you can self-host Kan with Docker Compose. This will set up everything for you including your postgres database and automatically run migrations.
1. Create a `.env` file with your environment variables (see [Environment Variables](#environment-variables) section below)
2. Use the [docker-compose.yml](./docker-compose.yml) file provided in the repository, which sets up Postgres, runs migrations, and starts the web service
3. Start the containers in detached mode:
```bash
docker compose up -d
```
The application will be available at http://localhost:3000 (or the port specified in `WEB_PORT`).
**Managing containers:**
- To stop the containers: `docker compose down`
- To view logs: `docker compose logs -f`
- To restart the containers: `docker compose restart`
- To rebuild after code changes: `docker compose up -d --build`
## Local Development
1. Clone the repository (or fork)
```bash
git clone https://github.com/kanbn/kan.git
```
2. Install dependencies
```bash
pnpm install
```
3. Copy `.env.example` to `.env` and configure your environment variables
4. Migrate database
```bash
pnpm db:migrate
```
5. Start the development server
```bash
pnpm dev
```
## Environment Variables
At minimum, you'll need:
| Variable | Description | Example |
| ----------------------- | ------------------------------ | ----------------------------------------- |
| `POSTGRES_URL` | PostgreSQL connection URL | `postgres://user:pass@localhost:5432/db` |
| `NEXT_PUBLIC_BASE_URL` | Base URL of your installation | `http://localhost:3000` |
| `BETTER_AUTH_SECRET` | Auth encryption secret | Random 32+ char string |
Optional integrations (email/SMTP, OAuth and OIDC login, S3-compatible file storage, Trello import, rate limiting, white labelling, and more) are configured through additional variables. See [.env.example](./.env.example) for the complete list.
## MCP Server
Kan ships with a [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server that lets any MCP-compatible AI client (Claude Desktop, Codex, Cursor, GitHub Copilot, and others) read and control your Kan instance using natural language.
Run it with `npx`, no clone or global install required:
```bash
npx -y @kan.bn/mcp
```
Configure it with two environment variables: `KAN_BASE_URL` (your Kan instance) and `KAN_API_TOKEN` (from **Settings → API Keys**). Then point your client's MCP config at the `npx -y @kan.bn/mcp` command.
See the [MCP Server docs](https://docs.kan.bn/integrations/mcp-server) for per-client config (Claude Desktop, Codex, and others), example prompts, the full tool reference, and troubleshooting.
## Contributing
We welcome contributions! Please read our [contribution guidelines](CONTRIBUTING.md) before submitting a pull request.
## Contributors
<a href="https://github.com/kanbn/kan/graphs/contributors">
<img src="https://contrib.rocks/image?repo=kanbn/kan" />
</a>
## Sponsors
[<img height="100" alt="image" src="https://github.com/user-attachments/assets/e331c71f-ac86-46a6-bceb-ce276de094b0" />](https://www.testmuai.com)
Proudly sponsored by [TestMu AI (formerly LambdaTest)](https://www.testmuai.com) - an AI-native testing cloud platform built for modern engineering teams. Covering everything from autonomous test creation and fast execution to testing AI agents like chatbots and voice assistants. If you're serious about testing, go check them out.
## License
Kan is licensed under the [AGPLv3 license](LICENSE).
## Contact
For support or to get in touch, please email [henry@kan.bn](mailto:henry@kan.bn) or start a [GitHub Discussion](https://github.com/kanbn/kan/discussions).