Sign upLogin

Artem-Schander/L5Modular

View on GitHub
Star
README.md

Summary

Maintainability
Test Coverage
<p align="center"><img width="200" src="https://l5modular.github.io/assets/logo-no-borders-bicolor-vibrant.svg" alt="L5Modular logo"></p>
<h3 align="center">L5Modular</h3>
<p align="center">Keep Your Laravel App Organized</p>
<br>
<p align="center">
    <a href="https://github.com/Artem-Schander/L5Modular/releases"><img src="https://img.shields.io/github/v/release/artem-schander/L5Modular" alt="latest release"></a>
    <a href="https://app.buddy.works/schanderartem/l5modular/pipelines/pipeline/377455"><img src="https://app.buddy.works/schanderartem/l5modular/pipelines/pipeline/377455/badge.svg?token=4b7b3c4d7519e9539b3182b6ab83a51aa0e08f1ff562c4b8a8a393c266a4ba67" alt="build"></a>
    <a href="https://codeclimate.com/github/Artem-Schander/L5Modular"><img src="https://img.shields.io/codeclimate/maintainability-percentage/Artem-Schander/L5Modular" alt="maintainability"></a>
    <a href="https://codeclimate.com/github/Artem-Schander/L5Modular"><img src="https://img.shields.io/codeclimate/coverage/Artem-Schander/L5Modular" alt="code coverage"></a>
    <a href="https://packagist.org/packages/artem-schander/l5-modular"><img src="https://img.shields.io/packagist/dt/artem-schander/l5-modular.svg" alt="downloads"></a>
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<a href='#contributors'><img src='https://img.shields.io/badge/contributors-7-orange.svg' alt='All Contributors'></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
    <a href="https://github.com/Artem-Schander/L5Modular/blob/master/LICENSE"><img src="https://img.shields.io/packagist/l/artem-schander/l5-modular" alt="license"></a>
</p>

<hr>

This package allows you to organize your Laravel project in a modular manner.  
You can simply drop or generate modules with their own controllers, models, views, routes, etc. into the `app/Modules` folder and go on working with them.

---

## Documentation

Check out the full documentation at [l5modular.github.io](https://l5modular.github.io)

---

## Installation

The easiest way to install this package is through your terminal via Composer.  
Run the following command in a bash prompt from your projects root
```bash
composer require artem-schander/l5-modular
```

#### Requirements

L5Modular v2 requires at least PHP 7.2 and Laravel 5.7  
Older PHP / Laravel versions are supported by L5Modular v1. 


<br>
<br>

---

## Contributors

Thanks goes to these wonderful people:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://github.com/juliomotol"><img src="https://avatars0.githubusercontent.com/u/21353103?v=4" width="100px;" alt=""/><br /><sub><b>Julio Motol</b></sub></a><br /><a href="https://github.com/Artem-Schander/L5Modular/commits?author=juliomotol" title="Code">💻</a> <a href="https://github.com/Artem-Schander/L5Modular/commits?author=juliomotol" title="Tests">⚠️</a> <a href="#tool-juliomotol" title="Tools">🔧</a></td>
    <td align="center"><a href="https://github.com/husseinferas"><img src="https://avatars1.githubusercontent.com/u/27640691?v=4" width="100px;" alt=""/><br /><sub><b>Hussein Feras</b></sub></a><br /><a href="https://github.com/Artem-Schander/L5Modular/commits?author=husseinferas" title="Code">💻</a> <a href="https://github.com/Artem-Schander/L5Modular/commits?author=husseinferas" title="Tests">⚠️</a> <a href="#tool-husseinferas" title="Tools">🔧</a></td>
    <td align="center"><a href="https://www.cideator.com"><img src="https://avatars0.githubusercontent.com/u/241825?v=4" width="100px;" alt=""/><br /><sub><b>Farhan Wazir</b></sub></a><br /><a href="https://github.com/Artem-Schander/L5Modular/commits?author=farhanwazir" title="Code">💻</a></td>
    <td align="center"><a href="http://alpin11.at"><img src="https://avatars3.githubusercontent.com/u/24294584?v=4" width="100px;" alt=""/><br /><sub><b>David Höck </b></sub></a><br /><a href="https://github.com/Artem-Schander/L5Modular/commits?author=davidhoeck" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/mrpamacs"><img src="https://avatars0.githubusercontent.com/u/1251025?v=4" width="100px;" alt=""/><br /><sub><b>Kis Viktor</b></sub></a><br /><a href="https://github.com/Artem-Schander/L5Modular/commits?author=mrpamacs" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/AkramBerkawy"><img src="https://avatars1.githubusercontent.com/u/3511510?v=4" width="100px;" alt=""/><br /><sub><b>Akram Berkawy</b></sub></a><br /><a href="https://github.com/Artem-Schander/L5Modular/commits?author=AkramBerkawy" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/tombombadilll"><img src="https://avatars2.githubusercontent.com/u/1056064?v=4" width="100px;" alt=""/><br /><sub><b>Thomas Eriksson</b></sub></a><br /><a href="https://github.com/Artem-Schander/L5Modular/issues?q=author%3Atombombadilll" title="Bug reports">🐛</a></td>
  </tr>
</table>

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

Also thanks to zyhn for the ["Modular Structure in Laravel 5" tutorial](http://ziyahanalbeniz.blogspot.com.tr/2015/03/modular-structure-in-laravel-5.html). Well explained and helped a lot.

<br>
<br>

---

## Contact

Feel free to join the [Slack](https://join.slack.com/t/l5modular/shared_invite/zt-dd53wpkn-pqT~2IWtTA8vWxQVWz4AHg) chat.

<br>
<br>

---

## License

L5Modular is licensed under the terms of the [MIT License](https://github.com/Artem-Schander/L5Modular/blob/master/LICENSE)
(See LICENSE file for details).