Download the PHP package grazulex/laravel-atlas without Composer

Laravel Atlas

Advanced Laravel application mapping and visualization toolkit. Analyze, document, and visualize your Laravel project architecture with comprehensive dependency mapping and multiple export formats.

📖 Table of Contents

• Overview
• ✨ Features
• 📦 Installation
• 🚀 Quick Start
• 🗺️ Architecture Mapping
• 📊 Export Formats
• 🔍 Analysis Tools
• ⚙️ Configuration
• 📚 Documentation & Wiki
• 💡 Examples
• 🧪 Testing
• 🔧 Requirements
• 🚀 Performance
• 🤝 Contributing
• 🔒 Security
• 📄 License

Overview

Laravel Atlas is an advanced application mapping and visualization toolkit that scans your Laravel project to generate comprehensive architectural documentation. It analyzes models, services, routes, jobs, events, commands, and their interconnections, then exports visual representations in multiple formats.

Perfect for code documentation, team onboarding, architecture reviews, and maintaining large enterprise applications.

🎯 Use Cases

Laravel Atlas is perfect for:

• Code Documentation - Generate comprehensive application maps
• Team Onboarding - Visual architecture overviews for new developers
• Architecture Reviews - Analyze application structure and dependencies
• Legacy Code Analysis - Understand complex existing applications
• Compliance Reporting - Generate architectural documentation
• 🧪 Architecture Testing - Validate application structure and enforce coding standards
• CI/CD Integration - Automated architecture analysis and reporting

✨ Features

• 🚀 Comprehensive Scanning - Analyze 16 Laravel component types
• 🗺️ Architecture Mapping - Generate detailed application structure maps
• 📊 Multiple Export Formats - Export to JSON, HTML, and PDF
• 🔍 Dependency Analysis - Track relationships and dependencies between components
• 📋 Extensible Architecture - Support for custom mappers and exporters
• 🎯 Smart Detection - Intelligent component discovery and classification
• 🧪 Analysis Reports - Comprehensive architectural analysis reports
• ⚡ CLI Integration - Powerful Artisan commands for map generation
• 💻 Programmatic API - Full PHP API with Atlas facade
• 📝 Documentation Generation - Auto-generate architecture documentation
• 🧪 Testing Integration - Use Atlas facade for architecture testing and validation

📦 Installation

Install the package via Composer:

💡 Auto-Discovery
The service provider will be automatically registered thanks to Laravel's package auto-discovery.

Publish configuration:

🚀 Quick Start

1. Generate Your First Map

This creates an HTML output showing all discovered components in your application.

2. Generate Specific Component Maps

3. Customize Export Formats

4. Access Generated Maps Programmatically

🗺️ Architecture Mapping

Laravel Atlas provides comprehensive architecture mapping capabilities through specialized mappers:

Available Component Types

Laravel Atlas can analyze 16 component types:

• models - Eloquent models with relationships, observers, and factories
• routes - Application routes with middleware and controllers
• commands - Artisan commands with their signatures and descriptions
• services - Application service classes with methods and dependencies
• notifications - Laravel notification classes with channels and methods
• middlewares - HTTP middleware with parameters and dependencies
• form_requests - Form request validation classes with rules and authorization
• events - Laravel event classes with their properties and methods
• controllers - Application controllers with their actions and dependencies
• resources - API resource classes with their transformations
• jobs - Queue job classes with their handles and dependencies
• actions - Single action controllers and action classes
• policies - Authorization policy classes with their methods
• rules - Custom validation rule classes
• listeners - Event listener classes with their handlers
• observers - Model observer classes with their lifecycle hooks

📊 Export Formats

Multiple export formats for different use cases:

HTML Export Features

The HTML export format provides an interactive, responsive dashboard with advanced features:

• 🌓 Dark Mode Support - Toggle between light and dark themes with persistent preference
• 📱 Responsive Design - Seamlessly works on desktop, tablet, and mobile devices
• 🔍 Component Navigation - Easy sidebar navigation between component types with live counts
• 📊 Visual Component Cards - Rich cards showing detailed component information with syntax highlighting
• 📈 Real-time Counts - Live component counts displayed in the navigation sidebar
• 🎨 Modern UI - Built with Tailwind CSS for a professional, enterprise-ready appearance
• 💻 Self-contained - Complete HTML files with no external dependencies required

Component Sections Available:

• 🧱 Models - with relationships, attributes, and metadata
• 🛣️ Routes - with middleware, controllers, and HTTP methods
• 💬 Commands - with signatures, arguments, and options
• 🔧 Services - with methods, dependencies, and flow analysis
• 📢 Notifications - with channels, methods, and dependencies
• 🛡️ Middlewares - with parameters, dependencies, and flow patterns
• 📋 Form Requests - with validation rules, authorization, and attributes
• ⚡ Events - with listeners, properties, and event flow
• 🎮 Controllers - with actions, dependencies, and request handling
• 🔄 Resources - with transformations, attributes, and API structure
• ⚙️ Jobs - with handlers, dependencies, and queue configuration
• 🎯 Actions - with single responsibilities and method signatures
• 🔐 Policies - with authorization methods and access control
• ✅ Rules - with validation logic and custom rule implementations
• 👂 Listeners - with event handling and processing logic
• 👁️ Observers - with model lifecycle hooks and event handling

Example HTML Generation:

Sample HTML Dashboard Features:

• Professional header with project information and dark mode toggle
• Sidebar navigation with component counts (e.g., "🧱 Models [3]", "🛣️ Routes [15]")
• Interactive component cards with collapsible sections
• Syntax-highlighted code examples and relationship mappings
• Responsive grid layouts that adapt to screen size
• Enterprise-ready styling suitable for documentation and presentations

📖 See HTML Export Examples in Wiki for complete sample reports and detailed documentation.

PDF Export Features

The PDF export format provides professional documentation suitable for presentations and reports:

• 📄 Professional Layout - Clean, enterprise-ready document formatting
• 📊 Comprehensive Coverage - All 16 component types in structured sections
• 🎨 Optimized for Print - A4 format with proper page breaks and typography
• 📝 Complete Documentation - Detailed component information with metadata
• 🔧 Self-contained - Complete PDF files ready for sharing and archiving

PDF Generation Examples:

PDF Features:

• Professional header with project information and generation timestamp
• Structured sections for each component type with detailed information
• Optimized typography and layout for readability
• Component metadata including relationships, dependencies, and configurations
• Suitable for documentation packages, compliance reports, and team presentations

Requirements for PDF Export:

• dompdf/dompdf package (automatically included as suggested dependency)
• ext-gd PHP extension for image processing

Programmatic Export

🧪 Testing Your Architecture

Laravel Atlas provides powerful capabilities for testing and validating your application's architecture. Use the Atlas facade in your tests to ensure your codebase follows intended patterns and standards.

Architecture Testing Examples

CI/CD Integration

📖 Learn More: Testing Architecture Guide for advanced testing strategies and examples.

🔍 Analysis Tools

Laravel Atlas provides comprehensive component analysis:

⚙️ Configuration

Laravel Atlas provides extensive configuration options:

📚 Documentation & Wiki

📖 Complete Documentation & Examples - Laravel Atlas Wiki

All documentation, examples, and advanced usage guides have been moved to our comprehensive Wiki:

🚀 Quick Links

• 📖 Home - Wiki homepage with navigation
• 🎯 Getting Started - Installation and basic usage
• 🗺️ Component Types - All 16 supported component types
• 📊 Export Formats - HTML, JSON, and PDF export details
• 🧪 Architecture Testing - Testing and validation guide
• ⚙️ Configuration - Complete configuration options
• 🔧 Advanced Usage - Power user features
• 🎨 HTML Dashboard - Interactive HTML export features

💡 Working Examples

• 💻 Code Examples - PHP code samples
• 📋 Command Examples - Artisan command usage
• 🏗️ CI/CD Integration - Pipeline integration examples
• 📱 Live Demos - Interactive demo reports

💡 Examples

📚 All Examples Available in Wiki

Quick Start Examples

Basic PHP Usage

📖 Complete Examples, Tutorials & Advanced Usage → php artisan atlas:export --type=controllers --format=html --output=docs/controllers.html

### Advanced Export Examples

📖 **[More Examples Available in Wiki](https://github.com/Grazulex/laravel-atlas/wiki/Examples)** - Complete working examples, tutorials, and advanced usage patterns.

## 🧪 Testing

Laravel Atlas includes testing utilities and can be tested in your application:

## 🔧 Requirements

- PHP: ^8.3
- Laravel: ^12.0
- Carbon: ^3.10

## 🚀 Performance

Laravel Atlas is optimized for performance:

- **Efficient Scanning**: Optimized file system scanning and parsing
- **Smart Caching**: Intelligent caching of analysis results
- **Memory Management**: Efficient memory usage for large applications
- **Incremental Updates**: Only scan changed files when possible

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

## 🔒 Security

If you discover a security vulnerability, please review our [Security Policy](SECURITY.md) before disclosing it.

## 📄 License

Laravel Atlas is open-sourced software licensed under the [MIT license](LICENSE.md).

---

**Made with ❤️ for the Laravel community**

### Resources

- **[📖 Wiki - Complete Documentation](https://github.com/Grazulex/laravel-atlas/wiki)** - All documentation and examples
- **[💬 Discussions](https://github.com/Grazulex/laravel-atlas/discussions)** - Community discussions
- **[🐛 Issue Tracker](https://github.com/Grazulex/laravel-atlas/issues)** - Bug reports and feature requests
- **[📦 Packagist](https://packagist.org/packages/grazulex/laravel-atlas)** - Package repository

### Community Links

- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - Our code of conduct
- [CONTRIBUTING.md](CONTRIBUTING.md) - How to contribute
- [SECURITY.md](SECURITY.md) - Security policy
- [RELEASES.md](RELEASES.md) - Release notes and changelog