codewithuali/laradoc

Intelligent Laravel project documentation generator with AI-powered chatbot

Maintainers

Details

github.com/codeWithUali/laradoc

Source

Issues

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

dev-main 2025-07-05 10:39 UTC

Requires

Requires (Dev)

MIT af883531fc366324b88ff5fc285580e70f1f9221

  • Umair Ali <me.woop@umair.lu>

This package is auto-updated.

Last update: 2025-07-05 10:39:36 UTC

README

Visit our website: https://umair.lu/community/laradoc

📦 Packagist & Meta

🛠️ Tech Stack

  • Language: PHP ^8.1
  • Framework: Laravel ^9.0|^10.0|^11.0
  • Key Dependencies:
    • guzzlehttp/guzzle ^7.0
    • symfony/console ^6.0
    • symfony/finder ^6.0
    • league/commonmark ^2.0
    • meilisearch/meilisearch-php ^0.35.0
    • spatie/laravel-permission ^5.0
    • livewire/livewire ^2.0
  • Dev Dependencies:
    • orchestra/testbench ^7.0|^8.0
    • phpunit/phpunit ^9.0|^10.0

Laradoc - Intelligent Laravel Documentation Generator

Visit our website: https://umair.lu/community/laradoc

Laradoc is an intelligent Laravel documentation generator that automatically analyzes your Laravel project and generates comprehensive documentation using AI-powered insights. Save hours of manual work and keep your documentation always up-to-date.

🌟 Features

  • 🤖 AI-Powered Analysis: Automatically analyze your Laravel project structure using advanced AI algorithms
  • 🔍 Advanced Search: Lightning-fast search with Meilisearch integration and database fallback
  • 💬 AI Chatbot: Ask questions about your codebase and get intelligent, contextual answers
  • ✏️ Live Editing: Edit documentation directly in the web interface with real-time preview
  • 🎨 Modern UI: Beautiful Bootstrap 5 interface with responsive design
  • 🔧 Multiple AI Providers: Support for OpenAI GPT-4, Claude, and Gemini
  • 📱 Responsive Design: Works perfectly on all devices
  • ⚡ High Performance: Optimized for speed with caching and efficient queries

🚀 Quick Start

Installation

composer require codewithuali/laradoc

Publish Configuration

php artisan vendor:publish --provider="Laradoc\Laradoc\LaradocServiceProvider"

Run Migrations

php artisan migrate

Configure AI Provider

Add your AI provider API key to your .env file:

# AI Provider Configuration
LARADOC_AI_PROVIDER=openai

# OpenAI Configuration
OPENAI_API_KEY=your_openai_api_key
OPENAI_MODEL=gpt-4

# Or Claude
ANTHROPIC_API_KEY=your_claude_api_key
CLAUDE_MODEL=claude-3-sonnet-20240229

# Or Gemini
GOOGLE_API_KEY=your_gemini_api_key
GEMINI_MODEL=gemini-pro

Generate Documentation

php artisan laradoc:generate

Access the Interface

Visit /laradoc in your browser to access the documentation interface.

📖 Documentation

For detailed documentation, visit our website: https://umair.lu/community/laradoc/docs

What Gets Documented

Laradoc automatically generates documentation for:

  • Authentication & Authorization: Guards, policies, gates, middleware
  • API Documentation: Controllers, routes, requests, responses
  • Database & Models: Eloquent models, relationships, migrations
  • Frontend & Views: Blade templates, components, assets
  • Services & Providers: Service providers, facades, helpers
  • Configuration: App config, environment variables
  • Testing: Test files, test coverage
  • Deployment: Deployment scripts, server configurations

🎯 Use Cases

  • Development Teams: Keep documentation in sync with code changes
  • Open Source Projects: Automatically generate comprehensive docs
  • Client Projects: Provide detailed documentation for clients
  • Code Reviews: Understand project structure quickly
  • Onboarding: Help new developers understand the codebase
  • Maintenance: Keep documentation updated as projects evolve

🛠️ Configuration

AI Provider Settings

// config/laradoc.php
'ai' => [
    'provider' => env('LARADOC_AI_PROVIDER', 'openai'), // openai, claude, gemini
    'model' => env('LARADOC_AI_MODEL', 'gpt-4'),
    'temperature' => env('LARADOC_AI_TEMPERATURE', 0.7),
    'max_tokens' => env('LARADOC_AI_MAX_TOKENS', 4000),
],

Search Settings

'search' => [
    'driver' => env('LARADOC_SEARCH_DRIVER', 'database'), // database, meilisearch
    'meilisearch' => [
        'host' => env('MEILISEARCH_HOST', 'http://localhost:7700'),
        'key' => env('MEILISEARCH_KEY'),
    ],
],

Documentation Settings

'documentation' => [
    'modules' => [
        'authentication' => true,
        'api' => true,
        'database' => true,
        'frontend' => true,
        'services' => true,
        'configuration' => true,
        'testing' => true,
        'deployment' => true,
    ],
    'auto_generate' => env('LARADOC_AUTO_GENERATE', true),
    'update_frequency' => env('LARADOC_UPDATE_FREQUENCY', 'daily'),
],

🌐 Website

Visit our official website for:

  • 📋 Feature Overview: Detailed feature descriptions and demos
  • 📚 Documentation: Complete installation and usage guides
  • 💰 Pricing: Transparent pricing plans
  • 👥 About Us: Learn about our team and mission
  • 📞 Contact: Get support and ask questions
  • 🎯 Use Cases: See how others are using Laradoc

Website: https://umair.lu/community/laradoc

🔧 Commands

Generate Documentation

php artisan laradoc:generate

Analyze Project Structure

php artisan laradoc:analyze

Clear Documentation Cache

php artisan laradoc:clear

🎨 Customization

Custom Views

Publish the views to customize the interface:

php artisan vendor:publish --tag=laradoc-views

Custom CSS/JS

Add your own styles and scripts:

php artisan vendor:publish --tag=laradoc-assets

Custom Modules

Extend Laradoc with your own documentation modules:

// app/Providers/AppServiceProvider.php
public function boot()
{
    Laradoc::addModule('custom', [
        'name' => 'Custom Module',
        'description' => 'Your custom documentation module',
        'icon' => 'fas fa-cog',
        'route' => 'laradoc.custom',
    ]);
}

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

git clone https://github.com/codewithuali/laradoc.git
cd laradoc
composer install

Running Tests

composer test

📄 License

Laradoc is open-sourced software licensed under the MIT license.

🙏 Acknowledgments

🔗 Links

📊 Star History

Star History Chart

Made with ❤️ for the Laravel community