PHPackages                             codewithuali/laradoc - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. codewithuali/laradoc

ActiveLibrary[Utility & Helpers](/categories/utility)

codewithuali/laradoc
====================

Intelligent Laravel project documentation generator with AI-powered chatbot

10PHP

Since Jul 5Pushed 12mo agoCompare

[ Source](https://github.com/codeWithUali/laradoc)[ Packagist](https://packagist.org/packages/codewithuali/laradoc)[ RSS](/packages/codewithuali-laradoc/feed)WikiDiscussions main Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

Laradoc - Intelligent Laravel Documentation Generator
=====================================================

[](#laradoc---intelligent-laravel-documentation-generator)

> **Visit our website**:

---

📦 Packagist & Meta
----------------------

[](#-packagist--meta)

- **Package Name:** `codewithuali/laradoc`
- **Packagist:**
- **Latest Version:** 1.0.0
- **Initial Release Date:** 2024-01-01
- **License:** MIT
- **Author:** Umair Ali ()

🛠️ Tech Stack
-------------

[](#️-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
=====================================================

[](#laradoc---intelligent-laravel-documentation-generator-1)

> **Visit our website**:

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
----------

[](#-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
-------------

[](#-quick-start)

### Installation

[](#installation)

```
composer require codewithuali/laradoc
```

### Publish Configuration

[](#publish-configuration)

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

### Run Migrations

[](#run-migrations)

```
php artisan migrate
```

### Configure AI Provider

[](#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

[](#generate-documentation)

```
php artisan laradoc:generate
```

### Access the Interface

[](#access-the-interface)

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

📖 Documentation
---------------

[](#-documentation)

For detailed documentation, visit our website:

### What Gets Documented

[](#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
-----------

[](#-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
----------------

[](#️-configuration)

### AI Provider Settings

[](#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-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-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
---------

[](#-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**:

🔧 Commands
----------

[](#-commands)

### Generate Documentation

[](#generate-documentation-1)

```
php artisan laradoc:generate
```

### Analyze Project Structure

[](#analyze-project-structure)

```
php artisan laradoc:analyze
```

### Clear Documentation Cache

[](#clear-documentation-cache)

```
php artisan laradoc:clear
```

🎨 Customization
---------------

[](#-customization)

### Custom Views

[](#custom-views)

Publish the views to customize the interface:

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

### Custom CSS/JS

[](#custom-cssjs)

Add your own styles and scripts:

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

### Custom Modules

[](#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
--------------

[](#-contributing)

We welcome contributions! Please see our [Contributing Guide](https://github.com/codewithuali/laradoc/blob/main/CONTRIBUTING.md) for details.

### Development Setup

[](#development-setup)

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

### Running Tests

[](#running-tests)

```
composer test
```

📄 License
---------

[](#-license)

Laradoc is open-sourced software licensed under the [MIT license](https://github.com/codewithuali/laradoc/blob/main/LICENSE).

🙏 Acknowledgments
-----------------

[](#-acknowledgments)

- [Laravel](https://laravel.com) - The amazing PHP framework
- [OpenAI](https://openai.com) - For GPT-4 integration
- [Anthropic](https://anthropic.com) - For Claude integration
- [Google AI](https://ai.google.dev) - For Gemini integration
- [Meilisearch](https://meilisearch.com) - For search functionality
- [Bootstrap](https://getbootstrap.com) - For the beautiful UI
- [Livewire](https://laravel-livewire.com) - For reactive components

🔗 Links
-------

[](#-links)

- **Website**:
- **Documentation**:
- **GitHub Issues**:
- **Discord**:

📊 Star History
--------------

[](#-star-history)

[![Star History Chart](https://camo.githubusercontent.com/c3f323b3f6534dead7982d595e2b10713244804fba176c0d09fc9fd14cab7b68/68747470733a2f2f6170692e737461722d686973746f72792e636f6d2f7376673f7265706f733d636f64657769746875616c692f6c617261646f6326747970653d44617465)](https://star-history.com/#codewithuali/laradoc&Date)

---

Made with ❤️ for the Laravel community

###  Health Score

15

—

LowBetter than 3% of packages

Maintenance37

Infrequent updates — may be unmaintained

Popularity2

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity14

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/0edc143fdb3acb3f920ba08c6de3dbf9e1fd41fcf7e061e1f1d63060946de007?d=identicon)[codeWithUali](/maintainers/codeWithUali)

---

Top Contributors

[![ualimxvp](https://avatars.githubusercontent.com/u/170113738?v=4)](https://github.com/ualimxvp "ualimxvp (6 commits)")

### Embed Badge

![Health badge](/badges/codewithuali-laradoc/health.svg)

```
[![Health](https://phpackages.com/badges/codewithuali-laradoc/health.svg)](https://phpackages.com/packages/codewithuali-laradoc)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)