README

Easily manage modular routes in Laravel projects — automatically create, load, and organize module routes and controllers in a professional, production-ready way.

📘 Table of Contents

Introduction
Features
Installation
Usage
Example Workflow
Contributing
License
Author

🚀 Introduction

Laravel Modular Routes is a lightweight package for modular route management. It allows developers to automatically create modules with controllers and route files and load them dynamically, keeping your application organized and production-ready.

Create a module in seconds:

php artisan make:module Customer

The routes and controllers are automatically generated and ready for use.

✨ Features

🧩 Automatic module scaffolding
📂 Supports API and Web routes per module
🔄 Dynamic autoloading of module classes (no composer.json edits required)
⚙️ Artisan commands for module management:
- make:module — Create a new module with CRUD routes
- module:list — List all modules
- module:clear-cache — Clear module cache
🧹 Clean folder structure (Modules/ModuleName/)
✅ Production-ready, scalable approach for large applications

⚙️ Installation

Require the package via Composer:

composer require sagar-s-bhedodkar/laravel-modular-routes:@dev

The package auto-discovers itself; no manual registration is required.

🧠 Usage

➕ Create a module

php artisan make:module Customer

This generates:

Modules/
 └── Customer/
     ├── Routes/api.php
     └── Http/Controllers/CustomerController.php

📝 Access routes

For example, if your module is Customer:

GET /api/customer → List all customers
POST /api/customer → Create a new customer
GET /api/customer/{id} → Show customer
PUT /api/customer/{id} → Update customer
DELETE /api/customer/{id} → Delete customer

🔄 List modules

php artisan module:list

🧹 Clear module cache

php artisan module:clear-cache

🧩 Example Workflow

Run php artisan make:module Customer
Add business logic to CustomerController
Routes are automatically available under /api/customer
Add more modules similarly without touching core routes

🤝 Contributing

Contributions are welcome!

Fork the repository
Create a feature branch: git checkout -b feature/new-feature
Commit your changes: git commit -m "Add new feature"
Push to your fork: git push origin feature/new-feature
Submit a Pull Request 🎉

📄 License

This package is open-sourced software licensed under the MIT license.

👨‍💻 Author

Sagar Sunil Bhedodkar 📧 sagarbhedodkar456@gmail.com 🌐 GitHub Profile

Made with ❤️ for Laravel developers who value modularity, automation, and production-ready code.

sagar-s-bhedodkar / laravel-modular-routes

Maintainers

Details