{"id":27935589,"url":"https://github.com/priom7/laravel2doc","last_synced_at":"2025-09-10T18:49:45.649Z","repository":{"id":291758988,"uuid":"978675968","full_name":"Priom7/laravel2doc","owner":"Priom7","description":"Automatically generate comprehensive documentation for Laravel applications, including Entity Relationship Diagrams (ERD), UML Class Diagrams, Sequence Diagrams, API Documentation, and more.","archived":false,"fork":false,"pushed_at":"2025-05-06T11:21:05.000Z","size":395,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T06:49:42.000Z","etag":null,"topics":["api-documentation","documentation","erdiagram","laravel","laravel2doc","nodejs","sequence-diagram","sql","uml-diagram"],"latest_commit_sha":null,"homepage":"https://youtu.be/ivZyPlLytCU","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Priom7.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-06T10:52:13.000Z","updated_at":"2025-05-06T11:21:08.000Z","dependencies_parsed_at":"2025-05-06T12:28:51.332Z","dependency_job_id":"0867834d-a858-40e8-b67e-2165784db14c","html_url":"https://github.com/Priom7/laravel2doc","commit_stats":null,"previous_names":["priom7/laravel2doc"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Priom7%2Flaravel2doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Priom7%2Flaravel2doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Priom7%2Flaravel2doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Priom7%2Flaravel2doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Priom7","download_url":"https://codeload.github.com/Priom7/laravel2doc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252831190,"owners_count":21810780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-documentation","documentation","erdiagram","laravel","laravel2doc","nodejs","sequence-diagram","sql","uml-diagram"],"created_at":"2025-05-07T06:49:44.210Z","updated_at":"2025-09-10T18:49:45.643Z","avatar_url":"https://github.com/Priom7.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Laravel2Doc (Live Now — May 2025)\n\n[![npm version](https://img.shields.io/npm/v/@priom7/laravel2doc?color=blue)](https://www.npmjs.com/package/@priom7/laravel2doc)\n[![npm downloads](https://img.shields.io/npm/dt/@priom7/laravel2doc?label=Downloads\u0026color=green)](https://www.npmjs.com/package/@priom7/laravel2doc)\n[![License: MIT](https://img.shields.io/badge/license-MIT-yellow.svg)](LICENSE)\n[![Node.js](https://img.shields.io/badge/Node.js-%3E=14.0.0-brightgreen)](https://nodejs.org/)\n[![Made by priom7](https://img.shields.io/badge/Made%20by-priom7-blueviolet)](https://github.com/priom7)\n\n\u003e Automatically generate beautiful, interactive documentation for Laravel projects in seconds.\n\n---\n\n### ⭐ Feel free to leave a star and follow for updates!\n### 📣 Feedback is always welcome — suggest features you'd like to see!\n\n📖 **Read the article**:  \n\u003ca href=\"https://medium.com/@priom7197/laravel2doc-generate-sequence-diagrams-from-your-laravel-application-in-seconds-1-2-84bf8ac8a193\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/Read%20Article-%23000000?style=for-the-badge\u0026logo=medium\u0026logoColor=white\" alt=\"Read Article\"\u003e\n\u003c/a\u003e\n\n---\n\n## ✨ Features\n\n- 📊 **ERD** — Entity Relationship Diagrams\n- 📝 **UML** — Class Diagrams for Models\n- 🔄 **Sequence Diagrams** — Component interaction flows\n- 📚 **API Docs** — Endpoints, controllers, routes\n- 🚀 **Interactive Viewer** — Browse via built-in web interface\n- 🔍 **Zero Config** — Auto-analyzes Laravel project structure\n\n---\n\n## 📦 Installation\n\n### Global:\n\n```bash\nnpm install -g @priom7/laravel2doc\n````\n\n### Local (within a Laravel project):\n\n```bash\ncd your-laravel-project\nnpm install @priom7/laravel2doc\n```\n\n---\n\n## 🚀 Usage\n\nInside your Laravel project:\n\n```bash\nnpx laravel2doc\n```\n\nThis generates documentation in the `laravel2doc/` folder and launches a web viewer.\n\n### ⚙️ Options\n\n| Flag                 | Description                       | Default       |\n| -------------------- | --------------------------------- | ------------- |\n| `-p, --port \u003cnum\u003e`   | Port for local server             | `3333`        |\n| `-o, --output \u003cdir\u003e` | Directory to output documentation | `laravel2doc` |\n\n### 🧪 Demo Mode\n\nTry it outside a Laravel project to see a live example:\n\n```bash\nnpx laravel2doc\n```\n\n---\n\n## 🧾 Generated Documentation\n\n### 📊 Entity Relationship Diagram (ERD)\n\n* Tables, columns, data types\n* Primary/foreign keys, relationships\n\n\u003cdiv align=\"center\"\u003e\n   \u003cimg src=\"https://github.com/Priom7/laravel2doc/blob/main/erd-sample.png\" alt=\"ERD Sample\" width=\"100%\"\u003e\n\u003c/div\u003e\n\n---\n\n### 🏗 UML Class Diagram\n\n* Model properties, methods\n* Relationships and inheritance\n\n\u003cdiv align=\"center\"\u003e\n   \u003cimg src=\"https://github.com/Priom7/laravel2doc/blob/main/uml-sample.png\" alt=\"UML Sample\" width=\"100%\"\u003e\n\u003c/div\u003e\n\n---\n\n### 🔄 Sequence Diagrams\n\n* Controller method flows\n* CRUD interaction flow\n\n\u003cdiv align=\"center\"\u003e\n   \u003cimg src=\"https://github.com/Priom7/laravel2doc/blob/main/sequence-sample.png\" alt=\"Sequence Sample\" width=\"100%\"\u003e\n\u003c/div\u003e\n\n---\n\n### 🌐 API Documentation\n\n* Routes, HTTP methods, controllers\n* Parameter and handler mappings\n\n\u003cdiv align=\"center\"\u003e\n   \u003cimg src=\"https://github.com/Priom7/laravel2doc/blob/main/api-sample.png\" alt=\"API Sample\" width=\"100%\"\u003e\n\u003c/div\u003e\n\n---\n\n## 🧠 How It Works\n\n1. **Scans** Laravel models for relationships and attributes\n2. **Parses** migrations to reconstruct DB schema\n3. **Analyzes** controllers and route files\n4. **Generates** Mermaid-based diagrams and structured API docs\n5. **Serves** everything via a local web interface\n\n---\n\n## 🛠 Requirements\n\n* Node.js 14+\n* Laravel 8+ project\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome! Feel free to submit a pull request or feature request.\n\n---\n\n## 👨‍💻 Author\n\nCreated by [@priom7](https://github.com/priom7)\nMd Sharif Alam\n\n---\n\n\u003e 🌟 Found it useful? Give it a ⭐ on GitHub and share with Laravel developers!\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpriom7%2Flaravel2doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpriom7%2Flaravel2doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpriom7%2Flaravel2doc/lists"}