feat: update readme add contributing.md

This commit is contained in:
Henry
2025-05-29 13:13:40 +01:00
parent ffb3cec6a8
commit c1b38fadef
2 changed files with 98 additions and 0 deletions

View File

@@ -19,6 +19,19 @@
<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)
@@ -27,3 +40,36 @@
- [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).