Skip to content

calderbuild/VibeDoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

139 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 VibeDoc: Your AI Product Manager & Architect

License: MIT Python 3.11+ Gradio PRs Welcome

Transform Ideas into Complete Development Plans in 60-180 Seconds

AI-powered Product Manager & Software Architect that generates technical documentation, architecture diagrams, and AI coding prompts

🌐 Online Demo | 🎬 Demo Video | 🤝 Contributing | 💬 Discussions | 中文文档


✨ Why VibeDoc?

As a developer, product manager, or entrepreneur, you face these challenges:

  • 💭 Great Ideas, No Plan? You have ideas but don't know how to turn them into actionable development plans
  • Documentation Takes Forever? Writing technical specs and architecture docs consumes massive time
  • 🤖 AI Tools Confusing? You want AI-assisted coding but struggle with effective prompt engineering
  • 📊 Missing Professional Diagrams? You need architecture, flow, and Gantt charts but lack design tools expertise

VibeDoc Solves Everything!

VibeDoc Interface

🎯 Core Features

📋 Intelligent Development Plan Generation

Enter your product idea - AI generates a complete plan in 60-180 seconds:

  • Product Overview - Background, target users, core value proposition
  • Technical Solution - Tech stack selection, architecture design, technology comparison
  • Development Plan - Phased implementation, timeline, resource allocation
  • Deployment Strategy - Environment setup, CI/CD pipeline, operations monitoring
  • Growth Strategy - Market positioning, operations advice, growth tactics

🤖 AI Coding Prompt Generation

Generate ready-to-use prompts for each feature module, supporting:

  • Claude - Code generation, architecture design
  • GitHub Copilot - Intelligent code completion
  • ChatGPT - Technical consultation, code optimization
  • Cursor - AI-assisted programming

AI Coding Prompts

📊 Auto-Generated Visual Diagrams

Professional diagrams using Mermaid:

  • 🏗️ System Architecture - Component relationships visualization
  • 📈 Business Flowcharts - Business logic visualization
  • 📅 Gantt Charts - Project timeline at a glance
  • 📊 Tech Comparison Tables - Technology decision reference

📁 Multi-Format Export

One-click export for different scenarios:

  • Markdown (.md) - Version control friendly, GitHub display
  • Word (.docx) - Business documents, project reports
  • PDF (.pdf) - Formal proposals, print archives
  • HTML (.html) - Web display, online sharing

Generated Example

💡 Real-World Example

Input Idea

Develop an AR sign language translation app that can translate sign language
into voice and text in real-time, and also translate voice and text into
sign language gestures displayed in AR

Generated Output

📄 View Complete Development Plan (10,000+ words)

The AI-generated plan includes:

1. Product Overview

  • Target users (deaf community, healthcare workers, educators)
  • Core features (real-time translation, multi-language support, AR visualization)
  • Market positioning and competitive analysis

2. Technical Architecture

Complete system architecture with Mermaid diagrams showing:

  • User interface components
  • Backend services
  • ML model integration
  • Database design
  • AR rendering pipeline

3. Technology Stack

  • Frontend: React Native (cross-platform)
  • Backend: Node.js + Express
  • ML Models: TensorFlow for sign language recognition
  • NLP: spaCy for natural language processing
  • AR: ARKit (iOS) / ARCore (Android)
  • Database: MongoDB

4. Development Timeline

6-month plan with 3 major milestones:

  • Month 1-2: Core recognition & translation engine
  • Month 3-4: AR integration & UI development
  • Month 5-6: Testing, optimization & deployment

5. 12+ AI Coding Prompts

Ready-to-use prompts for each module. Example:

Feature: Hand Gesture Recognition Model

Context:
Building a real-time hand gesture recognition system for sign language translation.
Need to detect and classify hand positions, movements, and facial expressions.

Requirements:
- Process video frames at 30+ FPS
- Recognize 500+ sign language gestures
- Support continuous gesture sequences
- Handle varying lighting conditions

Tech Stack:
- TensorFlow/Keras for model training
- MediaPipe for hand landmark detection
- OpenCV for image preprocessing

Constraints:
- Must run on mobile devices (iOS/Android)
- Model size < 50MB for mobile deployment
- Inference time < 100ms per frame

Expected Output:
- Model architecture code
- Training pipeline
- Data preprocessing functions
- Mobile optimization strategies

🚀 Quick Start

🌐 Online Demo (Recommended)

👉 Try VibeDoc Now - No installation required!

Experience the full functionality:

  1. Enter your product idea (e.g., "Build a smart fitness app")
  2. Optionally add reference URLs for context
  3. Click generate and wait 60-180 seconds
  4. Get complete development plan with AI coding prompts
  5. Export to Markdown/Word/PDF/HTML formats

💻 Local Installation

Prerequisites

Installation Steps

# 1. Clone the repository
git clone https://github.com/JasonRobertDestiny/VibeDoc.git
cd VibeDoc

# 2. Create virtual environment (recommended)
python -m venv venv

# Activate virtual environment
# Windows:
venv\Scripts\activate
# macOS/Linux:
source venv/bin/activate

# 3. Install dependencies
pip install -r requirements.txt

# 4. Configure environment variables
cp .env.example .env
# Edit .env file and add your API Key

Configuration

In .env file:

# Required: SiliconFlow API Key (free registration)
SILICONFLOW_API_KEY=your_api_key_here

# Optional: Advanced Configuration
API_TIMEOUT=300
LOG_LEVEL=INFO
ENVIRONMENT=production

Run Application

python app.py

Application starts at:

🐳 Docker Deployment (Optional)

# Build image
docker build -t vibedoc .

# Run container
docker run -p 7860:7860 \
  -e SILICONFLOW_API_KEY=your_key \
  vibedoc

🏗️ Technical Architecture

Modular architecture design:

┌─────────────────────────────────────────┐
│         Gradio Web Interface            │
│   (User Interaction + UI + Export)      │
└─────────────────┬───────────────────────┘
                  │
┌─────────────────▼───────────────────────┐
│       Core Processing Engine            │
├─────────────────────────────────────────┤
│  • Input Validation & Optimization      │
│  • AI Generation Coordination           │
│  • Content Quality Control              │
│  • Multi-format Export                  │
└──┬────────┬──────────┬─────────┬────────┘
   │        │          │         │
   ▼        ▼          ▼         ▼
┌──────┐ ┌────────┐ ┌──────┐ ┌──────────┐
│ AI   │ │Prompt  │ │Content│ │Export    │
│Model │ │Optimizer│ │Validator│ │Manager   │
└──────┘ └────────┘ └──────┘ └──────────┘

Technology Stack

  • Frontend: Gradio 5.34.1 - Fast AI app interface
  • AI Model: Qwen2.5-72B-Instruct - Alibaba Cloud
  • Chart Rendering: Mermaid.js - Code-based diagrams
  • Document Export: python-docx, reportlab
  • Async Processing: asyncio, aiofiles

📊 Performance Metrics

Metric Performance
Generation Speed 60-180 seconds
Success Rate >95%
Content Quality 85/100 average
Export Formats 4 formats

🎨 Use Cases

👨‍💻 Developers

  • ✅ Validate technical feasibility quickly
  • ✅ Generate project documentation
  • ✅ Get AI coding prompts
  • ✅ Learn architecture best practices

📊 Product Managers

  • ✅ Transform requirements into technical solutions
  • ✅ Create project planning documents
  • ✅ Estimate development cycles
  • ✅ Build project proposals

🎓 Students & Learners

  • ✅ Learn software development best practices
  • ✅ Understand architecture design
  • ✅ Prepare for technical interviews
  • ✅ Plan graduation projects

🚀 Entrepreneurs

  • ✅ Validate product ideas quickly
  • ✅ Generate technical plans for investors
  • ✅ Plan MVP development
  • ✅ Assess implementation costs

🤝 Contributing

We welcome all contributions:

  • 🐛 Report Bugs
  • 💡 Suggest Features
  • 📝 Improve Documentation
  • 🔧 Submit Code

Steps

  1. Fork this project
  2. Create feature branch (git checkout -b feature/AmazingFeature)
  3. Commit changes (git commit -m 'Add AmazingFeature')
  4. Push to branch (git push origin feature/AmazingFeature)
  5. Submit Pull Request

See CONTRIBUTING.md for details.

💬 Join Community

Join the VibeDoc community to share experiences, get support, and discuss ideas!

VibeDoc Community QR Code

Scan to Join VibeDoc Community

Share Experiences | Get Support | Join Discussions

📝 Documentation

🎯 Roadmap

v2.1 (Planned)

  • More AI models (GPT-4, Claude, etc.)
  • Team collaboration features
  • Version management
  • Online editor

v2.2 (Planned)

  • Mobile support
  • Multi-language (English, Japanese)
  • Template marketplace
  • API interface

🙏 Acknowledgments

  • Qwen2.5-72B-Instruct by Alibaba Cloud
  • Gradio team
  • SiliconFlow API services
  • All contributors and users ❤️

📄 License

MIT License

📞 Contact

⭐ Star History

If this project helps you, give us a Star ⭐!

Star History Chart


🚀 Empower Every Idea with AI

Made with ❤️ by the VibeDoc Team

About

🚀 Your AI Product Manager & Architect - Transform ideas into complete development plans with AI coding prompts in 60-180 seconds

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors