VibeCoding System

Um framework de desenvolvimento orientado a conversas para criação rápida de MVP e POC.

Documentação

VibeCoding System 🚀

Framework de Desenvolvimento Orientado por Conversa para Criação Rápida de MVP/POC

O VibeCoding transforma o desenvolvimento de software tradicional em uma experiência de conversa natural guiada por IA. Através de diálogos inteligentes com serviços MCP profissionais, construa MVPs e POCs rapidamente.

📚 Navegação Completa da Documentação

🎯 Guia de Configuração (leia em ordem)

Guia Completo de Configuração de IDE - Documento principal de configuração, suporta todos os MCP Hosts
Instruções Específicas para Cursor MCP - Leitura obrigatória para usuários do Cursor
Guia de Configuração MCP - Configuração avançada e solução de problemas
Guia de Implantação - Implantação em ambiente de produção

🛠️ Referência de Ferramentas e Comandos

Manual Completo de Referência de Ferramentas - Descrição detalhada de todas as 34+ ferramentas
Design do Sistema de Comandos Concisos - Redesign de comandos orientado por UX
Coleção de Exemplos de Configuração MCP - Exemplos de configuração para vários cenários

🏗️ Arquitetura e Avançado

Explicação da Estrutura do Projeto - Arquitetura do projeto e organização de arquivos
Documentação de Referência da API - Documentação completa da API
Design de Arquitetura - Detalhes da arquitetura do sistema

🚀 Fluxo Completo de Inicialização

📦 Passo 1: Instalação e Configuração do Sistema

# 1. 複製 VibeCoding 模板
git clone https://github.com/Zenobia000/vibeCoding-mcp.git
cd vibeCoding-template

# 2. 安裝依賴並建構系統
npm install && npm run build

# 3. 驗證系統狀態
npm run vibecoding status
# 預期輸出: ✅ All VibeCoding services are enabled

# 4. 測試提示系統
npm run test:prompts
# 預期輸出: 🎉 FULLY OPERATIONAL - All prompts are ready!

🏗️ Passo 2: Crie sua Pasta de Projeto

🚀 Método 1: Criação de Projeto Aprimorada com Um Clique (Recomendado)

# 建立新專案目錄
mkdir my-awesome-project
cd my-awesome-project

# 🚀 一鍵創建 VibeCoding 增強專案結構 (含專業模板)
# 🌟 推薦使用 v3 版本 (完整整合 v1+v2 所有優勢)
node /path/to/your/vibeCoding-template/scripts/create-enhanced-project-v3.cjs

# 其他版本選擇：
# v2 版本 (架構優化，遵循 .vibecoding/prompts 指導原則)
node /path/to/your/vibeCoding-template/scripts/create-enhanced-project-v2.cjs

# v1 版本 (完整內容)
node /path/to/your/vibeCoding-template/scripts/create-enhanced-project.cjs

# 🎉 完成！自動創建了：
# ✅ 5個開發階段資料夾 + 完整子資料夾結構
# ✅ 基於 design_templates 的專業模板
# ✅ 開發指南、測試策略、部署指南
# ✅ 專案簡報、架構文檔、ADR 模板
# ✅ README.md 和 .gitignore 文件

📝 Método 2: Criação Manual da Estrutura Básica

# 建立新專案目錄 (在任何位置)
mkdir my-awesome-project
cd my-awesome-project

# 初始化專案結構 (可選，VibeCoding 會自動建立)
mkdir -p {src,tests,docs,config}

# 初始化 git (推薦)
git init
echo "node_modules/" > .gitignore
echo "dist/" >> .gitignore
echo ".env" >> .gitignore

# 建立基本 package.json (可選，VibeCoding 可協助生成)
npm init -y

⚙️ Passo 3: Configure o IDE e a Conexão MCP

Cursor IDE (Recomendado - sem necessidade de chave de API)

Abra o arquivo de configuração do Cursor IDE:

# Windows
code "$env:APPDATA\Cursor\User\settings.json"

# macOS  
code "~/Library/Application Support/Cursor/User/settings.json"

# Linux
code ~/.config/Cursor/User/settings.json

Adicione a configuração MCP do VibeCoding:

{
  "mcpServers": {
    "vibecoding-context-manager": {
      "command": "node",
      "args": ["/path/to/your/vibeCoding-template/dist/vibe-services/context-manager/index.js"],
      "description": "VibeCoding 上下文管理服務"
    }
  },
  "vibecoding.enabled": true,
  "vibecoding.defaultProvider": "cursor"
}

Importante: Substitua /path/to/your/vibeCoding-template/ pelo seu caminho real

Claude Desktop

{
  "mcpServers": {
    "vibecoding-context-manager": {
      "command": "node", 
      "args": ["/path/to/your/vibeCoding-template/dist/vibe-services/context-manager/index.js"],
      "env": {
        "ANTHROPIC_API_KEY": "你的_ANTHROPIC_金鑰"
      }
    }
  }
}

Outros IDEs

📖 Guia de Configuração Completo: Guia Completo de Configuração de IDE - Suporta VSCode, WebStorm, etc.

📖 Detalhes: Guia Específico para Cursor MCP

🎯 Passo 4: Inicie seu Primeiro Projeto VibeCoding

# 在你的專案資料夾中，使用 Cursor 或 Claude Desktop
# 輸入以下指令開始：

# 🆕 簡潔指令 (推薦)
@vibe start "我的專案名稱"

# 📝 完整指令 (向後相容)
@vibecoding-context-manager start-clarification

✅ Passo 5: Verifique se a Configuração Foi Bem-sucedida

Teste os seguintes comandos no seu IDE:

# 測試基本連接
@vibe start "測試專案"

# 如果看到類似以下回應，表示設定成功：
# 🚀 項目澄清已啟動
# 項目ID: proj_xxxxx
# 問題: 請描述這個專案的主要目標和預期解決的問題？

🌟 Destaques Principais

⚡ Sistema de Comandos Revolucionário

🆕 Comandos Concisos: @vibe start "專案名" - redução média de 77% na digitação
🔄 Compatibilidade Retroativa: comandos completos ainda funcionam
🧠 Conversa Inteligente: fluxo de desenvolvimento orientado por linguagem natural

🤖 6 Serviços MCP Profissionais

Serviço	Função	Comando Conciso
📋 Context Manager	Esclarecimento do projeto e gerenciamento de contexto	`@vibe start`, `@vibe prd`
⚡ Code Generator	Geração de código orientada por IA	`@vibe code`, `@vibe api`
📦 Dependency Tracker	Análise inteligente de dependências	`@vibe deps`, `@vibe scan`
🧪 Test Validator	Geração automatizada de testes	`@vibe test`, `@vibe cover`
📚 Doc Generator	Criação inteligente de documentação	`@vibe doc`, `@vibe readme`
🚀 Deployment Manager	Automação de CI/CD e infraestrutura	`@vibe deploy`, `@vibe monitor`

💡 Vantagens Técnicas

Suporte a múltiplos provedores de IA: OpenAI, Anthropic, Gemini, modelos locais
Fluxo de trabalho ciente do estágio: orientação dinâmica de IA adaptada ao estágio de desenvolvimento
Sistema de templates: biblioteca rica de templates com aprimoramento por IA
Configuração a quente: alterne provedores em tempo de execução sem reiniciar

🎮 Fluxo de Trabalho Completo de Desenvolvimento

🏗️ Comece na Pasta do Seu Projeto

# 進入你的專案目錄
cd my-awesome-project

# 開啟 Cursor IDE 或其他已配置的 MCP Host
code .  # 或 cursor .

📋 Fase 1: Esclarecimento do Projeto e Coleta de Requisitos

# 🎯 1. 開始新專案澄清
@vibe start "任務管理系統"
# 系統提供 7 個結構化問題收集需求

# 🗨️ 2. 逐一回答澄清問題
@vibe ask "主要解決團隊協作和任務追蹤問題"
# 系統會引導你完成所有 7 個澄清問題

# 📋 3. 生成產品需求文檔 (PRD)
@vibe prd
# 自動創建全面的產品需求文檔並保存到專案中

🏗️ Fase 2: Design e Arquitetura

# 📐 4. 生成實施計劃
@vibe plan
# 基於 PRD 生成詳細的技術實施計劃

# 🏛️ 5. 設計系統架構
@vibe arch "微服務架構，使用 Node.js + Express + MongoDB"
# 生成架構圖和技術選型說明

💻 Fase 3: Implementação do Desenvolvimento

# 🚀 6. 開始代碼開發
@vibe code "用戶認證系統，包含註冊、登入、JWT 驗證"
@vibe api "任務 CRUD 接口，支援建立、讀取、更新、刪除"

# 🔄 7. 代碼審查與重構
@vibe review "[剛生成的代碼]"
@vibe refactor "提升性能和可讀性"

🧪 Fase 4: Testes e Validação

# 🧪 8. 生成測試代碼
@vibe test
@vibe mock "[API 代碼]"

# 📊 9. 檢查測試覆蓋率
@vibe cover
# 驗證代碼品質和測試覆蓋率

🚀 Fase 5: Implantação e Monitoramento

# 📚 10. 生成文檔
@vibe doc
@vibe readme

# 🚀 11. 部署應用
@vibe deploy
# 自動設定 CI/CD 流程並部署到雲端平台

🎯 Modo de Prototipagem Rápida (MVP em 30 minutos)

# 一鍵式快速開發流程
@vibe start "快速原型"        # 2 分鐘澄清
@vibe prd                     # 1 分鐘生成 PRD  
@vibe code "核心功能"         # 10 分鐘開發
@vibe test                    # 5 分鐘測試
@vibe deploy                  # 12 分鐘部署
# 🎉 30 分鐘完成 MVP！

🏗️ Arquitetura do Sistema

Arquitetura dos Serviços Principais

VibeCoding MCP Server
├── 📋 Context Manager       → 持久化對話與專案狀態
├── ⚡ Code Generator       → AI 驅動的代碼生成  
├── 📦 Dependency Tracker  → 智能依賴管理
├── 🧪 Test Validator      → 自動化測試與品質分析
├── 📚 Doc Generator       → 智能文檔創建
└── 🚀 Deployment Manager → CI/CD 與基礎設施自動化

Sistema de Prompts de IA

Localizado em .vibecoding/prompts/, fornece orientação inteligente:

Prompts principais (3): identidade do sistema, estilo de conversa, regras de colaboração
Prompts de serviço (6): prompts profissionais para cada serviço MCP
Prompts de fluxo de trabalho (5): orientação de desenvolvimento específica por estágio
Carregamento dinâmico: adapta-se ao estágio e contexto atuais do projeto

Estágios de Desenvolvimento

0_discovery/     → 需求收集和澄清
1_design/        → 架構和 API 設計
2_implementation/→ 源代碼和測試
3_validation/    → 測試報告和品質指標
4_deployment/    → 部署配置
knowledge-base/  → 模式、解決方案和回顧

🔧 Referência da API

API Principal do Context Manager

// 開始專案澄清
start-clarification(projectName: string, initialDescription?: string)

// 提供澄清回答
provide-clarification(questionIndex: number, answer: string)

// 生成 PRD
generate-prd()

// 生成實施計劃
generate-impl-plan()

APIs de Outros Serviços

Code Generator: generate-code, code-review, refactor-code
Dependency Tracker: analyze-dependencies, security-scan, update-dependencies
Test Validator: run-tests, validate-coverage, performance-test
Doc Generator: generate-docs, create-api-docs, generate-changelog
Deployment Manager: deploy-service, setup-monitoring, rollback-deployment

📖 Documentação Completa da API: Manual de Referência de Ferramentas

⚙️ Configuração e Personalização

Requisitos do Sistema

Node.js: >= 18.0.0
npm: >= 8.0.0
Sistema operacional: Windows 10/11, macOS, Linux
Memória: >= 4GB RAM

Configuração de Provedores de IA

# 環境變數設定
OPENAI_API_KEY=your_openai_key
ANTHROPIC_API_KEY=your_anthropic_key
GEMINI_API_KEY=your_gemini_key

Configuração Avançada

Configuração multi-ambiente: separação de ambientes de desenvolvimento, teste e produção
Configuração de colaboração em equipe: configurações compartilhadas e melhores práticas
Implantação em nível empresarial: considerações de segurança e escalabilidade

📖 Guia de Configuração Completo: Guia de Configuração MCP

🔍 Solução de Problemas

Correções Rápidas para Problemas Comuns

❌ Problemas Relacionados à Inicialização

# Q1: VibeCoding 系統初始化失敗
npm cache clean --force && npm install && npm run build

# Q2: npm run vibecoding status 指令無法執行
# 確保在 vibeCoding-template 目錄中執行
cd /path/to/your/vibeCoding-template
npm run vibecoding status

# Q3: MCP 服務無法啟動  
npm run build && npm run test:prompts

# Q4: 找不到 dist/ 目錄
# 重新建構系統
npm run build
ls -la dist/vibe-services/  # 確認服務檔案存在

❌ Problemas Relacionados à Configuração do Projeto

# Q5: 在專案資料夾中無法使用 @vibe 指令
# 確保 IDE 已正確配置 MCP 設定，並重啟 IDE

# Q6: 路徑配置問題 - 找不到 VibeCoding 服務
# 使用絕對路徑，確認 dist/ 目錄存在
# Windows 範例: "C:\\Users\\YourName\\vibeCoding-template\\dist\\vibe-services\\context-manager\\index.js"
# macOS/Linux 範例: "/Users/YourName/vibeCoding-template/dist/vibe-services/context-manager/index.js"

# Q7: 專案資料夾結構問題
# VibeCoding 會自動創建需要的資料夾，但你也可以手動建立：
mkdir -p {0_discovery,1_design,2_implementation,3_validation,4_deployment}

❌ Problemas Relacionados à Configuração do IDE

# Q8: Cursor IDE 無法識別 @vibe 指令
# 1. 檢查 settings.json 格式是否正確 (不能有註解)
# 2. 重啟 Cursor IDE
# 3. 確認 mcpServers 配置正確

# Q9: Claude Desktop 連接失敗
# 1. 檢查 claude_desktop_config.json 格式
# 2. 確認 API 金鑰設定正確
# 3. 重啟 Claude Desktop

# Q10: 權限問題 (Windows)
# 以管理員身分執行 PowerShell，設定執行政策：
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Obter Ajuda

📖 Solução de problemas completa: Guia de Configuração de IDE
💬 Suporte da comunidade: GitHub Issues
🐛 Relatar erros: GitHub Issues

🤝 Contribuindo

Aceitamos contribuições! Consulte o Guia de Contribuição para mais detalhes.

📝 Licença

Este projeto é licenciado sob a MIT License - consulte o arquivo LICENSE para mais detalhes.

✅ Lista de Verificação de Configuração Concluída

Antes de começar a usar o VibeCoding, verifique os seguintes itens:

🔧 Verificação da Configuração do Sistema

Node.js >= 18.0.0 (node --version)
VibeCoding baixado e compilado (npm run build com sucesso)
Status do sistema normal (npm run vibecoding status exibe ✅)
Sistema de prompts funcionando (npm run test:prompts exibe 🎉)

📁 Verificação da Configuração do Projeto

Pasta do projeto criada (mkdir my-project && cd my-project)
Git inicializado (configuração de git init e .gitignore)
IDE abriu o projeto (code . ou cursor .)

⚙️ Verificação da Configuração do IDE

Arquivo de configuração MCP modificado (settings.json ou claude_desktop_config.json)
Caminho do VibeCoding correto (use caminho absoluto)
IDE reiniciado (a configuração só tem efeito após reiniciar)
Comando de teste bem-sucedido (@vibe start "測試" respondeu)

🎯 Pronto para Começar o Desenvolvimento

Escolha o modo de desenvolvimento:
- 📋 Fluxo completo: comece pelo esclarecimento de requisitos (@vibe start "專案名")
- ⚡ Prototipagem rápida: modo MVP em 30 minutos
- 💻 Desenvolvimento direto: pule o esclarecimento e gere código diretamente

🚀 Agora aproveite a experiência de desenvolvimento conversacional orientada por IA!

📚 Caminho de Aprendizagem Recomendado

Iniciante: Guia Completo de Configuração de IDE → conclua um projeto simples
Intermediário: Manual Completo de Referência de Ferramentas → explore todos os recursos
Avançado: Documento de Design de Arquitetura → personalização e extensão

💡 Dica: Encontrou problemas? Consulte a 🔍 Solução de Problemas acima ou veja GitHub Issues