Add vibe-kanban
This commit is contained in:
99
docs/VIBE_KANBAN_QUICK_START.md
Normal file
99
docs/VIBE_KANBAN_QUICK_START.md
Normal file
@@ -0,0 +1,99 @@
|
||||
# Vibe Kanban Quick Start
|
||||
|
||||
Quick reference for using Vibe Kanban with managing-apps.
|
||||
|
||||
## Installation
|
||||
|
||||
No installation needed! Vibe Kanban runs via `npx`.
|
||||
|
||||
## Starting Vibe Kanban
|
||||
|
||||
**From Projects folder** (recommended - manages all projects):
|
||||
|
||||
```bash
|
||||
cd /Users/oda/Desktop/Projects
|
||||
npm run vibe-kanban
|
||||
```
|
||||
|
||||
Or directly:
|
||||
|
||||
```bash
|
||||
cd /Users/oda/Desktop/Projects
|
||||
npx vibe-kanban
|
||||
```
|
||||
|
||||
**Alternative: From managing-apps folder** (project-specific):
|
||||
|
||||
```bash
|
||||
cd /Users/oda/Desktop/Projects/managing-apps
|
||||
npx vibe-kanban
|
||||
```
|
||||
|
||||
## First Time Setup
|
||||
|
||||
1. **Start Vibe Kanban:**
|
||||
```bash
|
||||
npm run vibe-kanban
|
||||
```
|
||||
|
||||
2. **Complete setup dialogs:**
|
||||
- Configure your coding agent (Claude, Codex, etc.)
|
||||
- Set editor preferences
|
||||
- Configure GitHub integration (optional)
|
||||
|
||||
3. **Access the UI:**
|
||||
- Vibe Kanban will print a URL in the terminal
|
||||
- Usually: http://localhost:3000 (or random port)
|
||||
- Automatically opens in your default browser
|
||||
|
||||
## Configuration
|
||||
|
||||
Project-specific configuration is in `.vibe-kanban/config.json`:
|
||||
|
||||
- **MCP Servers**: dev-manager-mcp integration
|
||||
- **QA Automation**: Auto-start dev environments
|
||||
- **Task Statuses**: Configure when to auto-start environments
|
||||
|
||||
## Using with Dev Environments
|
||||
|
||||
When a task moves to "Ready for QA":
|
||||
|
||||
1. Vibe Kanban automatically calls `scripts/start-task-docker.sh`
|
||||
2. Creates isolated Docker environment
|
||||
3. Copies database from main repo
|
||||
4. Provides test URLs
|
||||
5. When done, automatically stops the environment
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
# Start Vibe Kanban
|
||||
npm run vibe-kanban
|
||||
|
||||
# Start dev-manager-mcp daemon (in separate terminal)
|
||||
npm run dev-manager:start
|
||||
|
||||
# Check dev-manager status
|
||||
npm run dev-manager:status
|
||||
|
||||
# Start dev environment manually
|
||||
npm run dev-env:start
|
||||
|
||||
# Stop dev environment
|
||||
npm run dev-env:stop TASK-123
|
||||
```
|
||||
|
||||
## Fixed Port
|
||||
|
||||
To use a fixed port:
|
||||
|
||||
```bash
|
||||
PORT=8080 npm run vibe-kanban
|
||||
```
|
||||
|
||||
## Resources
|
||||
|
||||
- [Official Documentation](https://www.vibekanban.com/docs/getting-started)
|
||||
- [GitHub Repository](https://github.com/BloopAI/vibe-kanban)
|
||||
- [MCP Integration Guide](docs/INSTALL_VIBE_KANBAN_AND_DEV_MANAGER.md)
|
||||
|
||||
Reference in New Issue
Block a user