https://github.com/jmrashed/laravel-module-generator
A simple and customizable Laravel Module Generator package to help you rapidly scaffold modular components in your Laravel application.
https://github.com/jmrashed/laravel-module-generator
generator laravel module package
Last synced: 2 months ago
JSON representation
A simple and customizable Laravel Module Generator package to help you rapidly scaffold modular components in your Laravel application.
- Host: GitHub
- URL: https://github.com/jmrashed/laravel-module-generator
- Owner: jmrashed
- License: mit
- Created: 2025-04-08T20:14:12.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-08T20:45:59.000Z (3 months ago)
- Last Synced: 2025-04-12T19:16:35.846Z (3 months ago)
- Topics: generator, laravel, module, package
- Language: PHP
- Homepage:
- Size: 21.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Module Generator
[](https://packagist.org/packages/jmrashed/laravel-module-generator)
[](https://github.com/jmrashed/laravel-module-generator/actions)
[](https://packagist.org/packages/jmrashed/laravel-module-generator)
[](https://github.com/jmrashed/laravel-module-generator/actions)
[](LICENSE)
> 🚀 A simple and flexible Laravel package to scaffold modular components with ease and speed.
The **Laravel Module Generator** helps you quickly create fully structured, reusable modules within your Laravel projects — perfect for organizing large applications and promoting clean architecture.
---
## 📚 Table of Contents
- [Features](#-features)
- [Installation](#-installation)
- [Configuration](#-configuration)
- [Usage](#-usage)
- [Basic Usage](#basic-usage)
- [Available Options](#available-options)
- [Real-World Example](#real-world-example)
- [Testing](#-testing)
- [Contributing](#-contributing)
- [License](#-license)
---
## ✨ Features
- 📦 Generate Laravel modules with MVC structure
- 🔧 Supports custom namespaces and folder structures
- 🧰 Command-line driven with Artisan commands
- 🔌 Easily customizable and extendable
- 🗂 Keeps your Laravel app clean, modular, and maintainable
---
## 🛠 Installation
### Via Composer
```bash
composer require jmrashed/laravel-module-generator --dev
```
> Alternatively, you can clone this repository:
```bash
git clone [email protected]:jmrashed/laravel-module-generator.git
cd laravel-module-generator
composer install
```
---
### Publish Configuration (Optional)
```bash
php artisan vendor:publish --tag=module-generator-config
```
This will create a `config/module-generator.php` file where you can customize module settings.
---
## ⚙️ Configuration
You can customize the following in `config/module-generator.php`:
- Base modules path (default: `modules/`)
- Default namespace
- Folder structure (e.g., Controllers, Models, Views, etc.)
- Custom routing configurations
- Middleware and service provider setups
This allows you to adapt the package to fit your project’s architecture standards.
---
## 🚀 Usage
### Basic Usage
To generate a new module, run:
```bash
php artisan make:module Blog
```
This will scaffold the module with default folders and routing files under `modules/Blog`.
### Available Options
| Option | Description |
|----------------|---------------------------------------------------|
| `--with-model` | Also create a model class for the module |
| `--api` | Generate an API-ready module (Controller + Routes)|
| `--force` | Overwrite module if it already exists |
### Real-World Example
To create an **API** module with a **Blog** model, simply run:
```bash
php artisan make:module Blog --with-model --api
```
This will create a `Blog` module under `modules/Blog/` with:
- `BlogController.php`
- `Blog.php` model
- `api.php` routes
Example structure:
```
modules/
└── Blog/
├── Controllers/
│ └── BlogController.php
├── Models/
│ └── Blog.php
├── Routes/
│ └── api.php
└── Views/
└── index.blade.php
```
---
## 🧪 Testing
To run tests:
```bash
php artisan test
```
Or directly with PHPUnit:
```bash
vendor/bin/phpunit
```
---
## 🤝 Contributing
We welcome contributions! If you'd like to contribute, please follow these steps:
1. **Fork** the repository
2. **Create** your branch (`git checkout -b feature/your-feature-name`)
3. **Commit** your changes (`git commit -am 'Add some feature'`)
4. **Push** to the branch (`git push origin feature/your-feature-name`)
5. **Create a Pull Request**
Please ensure that your code follows [PSR-12](https://www.php-fig.org/psr/psr-12/) coding standards and includes tests for new features.
For more detailed guidelines, please check the [CONTRIBUTING.md](CONTRIBUTING.md) file.
---
## 📃 License
This package is open-source software licensed under the [MIT license](LICENSE).
---
## 🙌 Acknowledgements
Built with ❤️ by [Md Rasheduzzaman](https://rasheduzzaman.com).
Follow me on [GitHub](https://github.com/jmrashed) or [Twitter](https://twitter.com/_rasheduzzaman) for more Laravel goodies.