Kaiban Board is an experimental UI designed to help you visualize, manage, and share your AI agent teams in a Kanban-style interface. Built on top of KaibanJS, it provides a powerful way to:
- 🔨 Create and manage AI agent teams visually
- 📊 Track tasks and workflows in real-time
- 🤝 Collaborate with your AI agents
- 🎯 Monitor progress and performance
- 🔍 Debug and optimize your AI workflows
- Node.js (v18 or higher)
- npm or yarn
- Git
- Clone the repository:
git clone https://github.com/kaiban-ai/kaiban-board.git
cd kaiban-board- Install dependencies:
npm install
# or
yarn install- Set up environment variables:
cp .env.example .env.localEdit .env.local and add your API keys.
- Start the development server:
npm run dev
# or
yarn devStorybook provides an isolated environment to develop and test the Kaiban Board component:
- Start Storybook:
npm run storybook
# or
yarn storybook- Open your browser and navigate to
http://localhost:6006
If you prefer to set up Kaiban Board manually follow these steps:
1. Install Kaiban Board via npm:
npm install kaiban-board2. Import Kaiban Board in your JavaScript file:
// Using ES6 import syntax for NextJS, React, etc.
import KaibanBoard from 'kaiban-board';
import 'kaiban-board/dist/index.css';3. Basic Usage Example
const teams = [
// Define your teams and tasks here
];
const uiSettings = {
//showWelcomeInfo: false
};
function App() {
return (
<div>
<KaibanBoard teams={teams} uiSettings={uiSettings} />
</div>
);
}
export default App;Join the Discord community to connect with other developers and get support. Follow us on Twitter for the latest updates.
We welcome contributions from the community. Please read the contributing guidelines before submitting pull requests.
- Fork the repo and create your branch from
main - Make your changes and test them thoroughly
- Ensure your code lints (
npm run lint) - Issue a pull request
- Update the README.md with details of changes if needed
- Update the .env.example if you've added new environment variables
- The PR will be merged once you have the sign-off of at least one maintainer
- Use Prettier for code formatting
- Follow the existing code style
- Write meaningful commit messages
- Add comments for complex logic
Kaiban Board is MIT licensed. See the LICENSE file for the complete license text.
For any questions or support, feel free to:
- Open an issue on GitHub
- Join our community discussions
- Contribute to the project
