https://github.com/Mapping-Apping/laravel2doc
Automate generating comprehensive documentation for Laravel applications, including Entity Relationship Diagrams (ERD), UML Class Diagrams, Sequence Diagrams, API Documentation, and more.
https://github.com/Mapping-Apping/laravel2doc
api-documentation documentation erdiagram laravel laravel2doc nodejs sequence-diagram sql uml-diagram
Last synced: about 1 month ago
JSON representation
Automate generating comprehensive documentation for Laravel applications, including Entity Relationship Diagrams (ERD), UML Class Diagrams, Sequence Diagrams, API Documentation, and more.
- Host: GitHub
- URL: https://github.com/Mapping-Apping/laravel2doc
- Owner: Mapping-Apping
- License: mit
- Created: 2025-05-06T10:52:13.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-24T12:49:25.000Z (7 months ago)
- Last Synced: 2025-10-12T12:19:19.747Z (6 months ago)
- Topics: api-documentation, documentation, erdiagram, laravel, laravel2doc, nodejs, sequence-diagram, sql, uml-diagram
- Language: JavaScript
- Homepage: https://laravel2doc.netlify.app/
- Size: 7.64 MB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel2Doc (Live Now — May 2025)
[](https://www.npmjs.com/package/@priom7/laravel2doc)
[](https://www.npmjs.com/package/@priom7/laravel2doc)
[](LICENSE)
[](https://nodejs.org/)
[](https://github.com/priom7)
> Automatically generate beautiful, interactive documentation for Laravel projects in seconds.
---
### ⭐ Feel free to leave a star and follow for updates!
### 📣 Feedback is always welcome — suggest features you'd like to see!
📖 **Read the article**:
---
## ✨ Features
- 📊 **ERD** — Entity Relationship Diagrams
- 📝 **UML** — Class Diagrams for Models
- 🔄 **Sequence Diagrams** — Component interaction flows
- 📚 **API Docs** — Endpoints, controllers, routes
- 🚀 **Interactive Viewer** — Browse via built-in web interface
- 🔍 **Zero Config** — Auto-analyzes Laravel project structure
---
## 📦 Installation
### Global:
```bash
npm install -g @priom7/laravel2doc
````
### Local (within a Laravel project):
```bash
cd your-laravel-project
npm install @priom7/laravel2doc
```
---
## 🚀 Usage
Inside your Laravel project:
```bash
npx laravel2doc
```
This generates documentation in the `laravel2doc/` folder and launches a web viewer.
### ⚙️ Options
| Flag | Description | Default |
| -------------------- | --------------------------------- | ------------- |
| `-p, --port ` | Port for local server | `3333` |
| `-o, --output ` | Directory to output documentation | `laravel2doc` |
### 🧪 Demo Mode
Try it outside a Laravel project to see a live example:
```bash
npx laravel2doc
```
---
## 🧾 Generated Documentation
### 📊 Entity Relationship Diagram (ERD)
* Tables, columns, data types
* Primary/foreign keys, relationships
---
### 🏗 UML Class Diagram
* Model properties, methods
* Relationships and inheritance
---
### 🔄 Sequence Diagrams
* Controller method flows
* CRUD interaction flow
---
### 🌐 API Documentation
* Routes, HTTP methods, controllers
* Parameter and handler mappings
---
## 🧠 How It Works
1. **Scans** Laravel models for relationships and attributes
2. **Parses** migrations to reconstruct DB schema
3. **Analyzes** controllers and route files
4. **Generates** Mermaid-based diagrams and structured API docs
5. **Serves** everything via a local web interface
---
## 🛠 Requirements
* Node.js 14+
* Laravel 8+ project
---
## 🤝 Contributing
Contributions are welcome! Feel free to submit a pull request or feature request.
---
## 👨💻 Author
Created by [@priom7](https://github.com/priom7)
Md Sharif Alam
---
> 🌟 Found it useful? Give it a ⭐ on GitHub and share with Laravel developers!