112 lines
5.3 KiB
Markdown
112 lines
5.3 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.
|
|
|
|
## Screenshot 👁️
|
|
|
|
<img width="1507" alt="hero-dark" src="https://github.com/user-attachments/assets/5f7b6ad3-f31d-4b45-93dc-0132b3f2afd4" />
|
|
|
|
## 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. Migrate database
|
|
|
|
```bash
|
|
pnpm db:migrate
|
|
```
|
|
|
|
5. Start the development server
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
## Environment Variables 🔐
|
|
|
|
| Variable | Description | Required | Example |
|
|
| -------------------------------- | ----------------------------- | ---------------- | --------------------------------------------- |
|
|
| `POSTGRES_URL` | PostgreSQL connection URL | Yes | `postgres://user:pass@localhost:5432/db` |
|
|
| `EMAIL_FROM` | Sender email address | Yes | `"Kan <hello@mail.kan.bn>"` |
|
|
| `SMTP_HOST` | SMTP server hostname | Yes | `smtp.resend.com` |
|
|
| `SMTP_PORT` | SMTP server port | Yes | `465` |
|
|
| `SMTP_USER` | SMTP username/email | Yes | `resend` |
|
|
| `SMTP_PASSWORD` | SMTP password/token | Yes | `re_xxxx` |
|
|
| `NEXT_PUBLIC_BASE_URL` | Base URL of your installation | Yes | `http://localhost:3000` |
|
|
| `BETTER_AUTH_SECRET` | Auth encryption secret | Yes | Random 32+ char string |
|
|
| `BETTER_AUTH_URL` | Auth callback URL | Yes | Same as `NEXT_PUBLIC_BASE_URL` |
|
|
| `BETTER_AUTH_TRUSTED_ORIGINS` | Allowed callback origins | For Google login | `http://localhost:3000,http://localhost:3001` |
|
|
| `GOOGLE_CLIENT_ID` | Google OAuth client ID | For Google login | `xxx.apps.googleusercontent.com` |
|
|
| `GOOGLE_CLIENT_SECRET` | Google OAuth client secret | For Google login | `xxx` |
|
|
| `S3_REGION` | S3 storage region | For file uploads | `WEUR` |
|
|
| `S3_ENDPOINT` | S3 endpoint URL | For file uploads | `https://xxx.r2.cloudflarestorage.com` |
|
|
| `S3_ACCESS_KEY_ID` | S3 access key | For file uploads | `xxx` |
|
|
| `S3_SECRET_ACCESS_KEY` | S3 secret key | For file uploads | `xxx` |
|
|
| `NEXT_PUBLIC_STORAGE_URL` | Storage service URL | For file uploads | `https://storage.kanbn.com` |
|
|
| `NEXT_PUBLIC_STORAGE_DOMAIN` | Storage domain name | For file uploads | `storage.kanbn.com` |
|
|
| `NEXT_PUBLIC_AVATAR_BUCKET_NAME` | S3 bucket name for avatars | For file uploads | `avatars` |
|
|
|
|
See `.env.example` for a complete list of supported environment variables.
|
|
|
|
## 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).
|