Skip to content

MEClouds/ai-docs-genrator

Repository files navigation

AI Documentation Generator

A modern, client-side application that transforms simple app descriptions into comprehensive, structured documentation using AI. Built with Next.js and designed with a developer-focused interface.

Features

🤖 AI-Powered Documentation Generation

  • Transform simple app ideas into detailed project documentation
  • Uses DeepSeek API by default (configurable to other providers)
  • Generates "English-to-React compilation ready" documentation
  • Structured output with proper file organization and linking syntax

🎨 Modern Developer Interface

  • Clean, professional UI inspired by bolt.new and v0.dev
  • Dark/light theme support with proper contrast ratios
  • Responsive design with collapsible sidebar
  • Real-time progress animations during generation

📁 File Management System

  • Download complete project documentation as ZIP files
  • Individual file downloads with proper formatting
  • File preview with syntax highlighting
  • Project structure visualization

💾 Local Storage & Project Management

  • Client-side storage for API keys and settings
  • Recent projects history
  • Auto-save functionality
  • Import/export settings

⚙️ Advanced Configuration

  • Multiple AI provider support (DeepSeek, OpenAI, etc.)
  • Customizable generation parameters (temperature, max tokens)
  • Custom system prompts
  • API key management with security features

Getting Started

Prerequisites

  • Node.js 18+
  • An API key from DeepSeek (or your preferred AI provider)

Installation

  1. Clone or download the project

  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev
  4. Open http://localhost:3000 in your browser

Configuration

  1. Click the Settings icon in the top-right corner
  2. Add your API key in the "API Configuration" tab
  3. Optionally customize generation parameters and preferences
  4. Save settings - they're stored locally in your browser

Usage

Basic Documentation Generation

  1. Describe Your App: Enter a simple description of your app idea in the textarea

    Example: "Create a todo app with user authentication, task categories, and real-time collaboration"
    
  2. Generate: Click "Generate Docs" to start the AI documentation process

  3. Review: Watch the progress animation and review the generated documentation structure

  4. Download: Export individual files or download the complete project as a ZIP

Project Templates

Use the sidebar templates for quick starts:

  • React App: Full-featured React application template
  • Dashboard: Analytics dashboard with charts and user management
  • Landing Page: SaaS product landing page template

Advanced Features

  • New Project: Click "New Project" to start fresh without losing current work
  • Recent Projects: Access previously generated projects from the sidebar
  • File Preview: View generated files with proper syntax highlighting
  • Settings Export: Backup and share your configuration settings

Documentation Structure

The AI generates documentation following the "English-to-React compilation format":

  • Project Overview: Main README and project structure
  • Page Documentation: Detailed specifications for each page/route
  • Component Documentation: Reusable component specifications
  • Layout Documentation: Layout and navigation structure
  • Configuration Files: Package.json, environment setup, etc.

Each file includes:

  • Detailed descriptions and specifications
  • Component linking syntax [[ComponentName]]
  • Props and state management details
  • Styling and behavior specifications
  • Integration requirements

Technology Stack

  • Framework: Next.js 14+ with App Router
  • Styling: Tailwind CSS v4 with custom design tokens
  • UI Components: shadcn/ui component library
  • AI Integration: Configurable AI providers (DeepSeek default)
  • File Management: JSZip for download functionality
  • Storage: Browser localStorage for client-side persistence
  • Theme: next-themes for dark/light mode support

API Providers

DeepSeek (Default)

  • Cost-effective and high-quality documentation generation
  • Fast response times
  • Good understanding of development patterns

OpenAI

  • GPT-4 and GPT-3.5 support
  • Excellent code understanding
  • Higher cost but premium quality

Custom Providers

  • Easily configurable for other AI providers
  • Extensible architecture for future integrations

Local Storage

All data is stored locally in your browser:

  • API Keys: Securely stored (never transmitted except to AI providers)
  • Settings: Generation preferences and configuration
  • Projects: Recent project history and documentation
  • Themes: UI preferences and customizations

Contributing

This is a client-side application with no backend dependencies. To contribute:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly in both light and dark modes
  5. Submit a pull request

Security

  • API keys are stored locally and never transmitted to third parties
  • All AI requests go directly from your browser to the configured provider
  • No server-side storage or logging of your data
  • Client-side only architecture ensures privacy

License

MIT License - feel free to use this project for personal or commercial purposes.

Support

For issues or questions:

  1. Check the settings configuration
  2. Verify your API key is valid
  3. Try refreshing the page to reset local storage
  4. Check browser console for detailed error messages

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors