76 lines
2.2 KiB
Markdown
76 lines
2.2 KiB
Markdown
|
|
|
|
<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://discord.gg/e6ejRb6CmT">Discord</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 (coming soon)** : Save time with reusable board templates
|
|
- ⚡️ **Integrations (coming soon)** : Connect your favourite tools
|
|
|
|
See our [roadmap](https://kan.bn/kan/roadmap) for upcoming features.
|
|
|
|
## 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)
|
|
|
|
## 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. Start the development server
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
## Contributing 🤝
|
|
|
|
We welcome contributions! Please read our [contribution guidelines](CONTRIBUTING.md) before submitting a pull request.
|
|
|
|
## 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 join our [Discord server](https://discord.gg/e6ejRb6CmT).
|