https://github.com/mpaleo/scaffolder
Scaffold out a laravel application. Craft your next application easier and faster
https://github.com/mpaleo/scaffolder
laravel php scaffold
Last synced: 5 months ago
JSON representation
Scaffold out a laravel application. Craft your next application easier and faster
- Host: GitHub
- URL: https://github.com/mpaleo/scaffolder
- Owner: mpaleo
- License: mit
- Created: 2015-11-08T22:18:45.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-03-02T03:41:01.000Z (over 7 years ago)
- Last Synced: 2024-11-16T02:42:08.198Z (over 1 year ago)
- Topics: laravel, php, scaffold
- Language: PHP
- Homepage: https://mpaleo.github.io/scaffolder
- Size: 365 KB
- Stars: 16
- Watchers: 5
- Forks: 8
- Open Issues: 10
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel scaffolder
[](LICENSE)
[](https://github.com/laravel/framework/tree/5.2)
[](https://waffle.io/mpaleo/scaffolder)
[](https://gitter.im/mpaleo/scaffolder)
Remove the headache of creating over and over again the base code for most of your projects.
You are free to extend it the way you need. This package only generate things that you need to start, always keeping the code clean and abstract. Are you hungry ? Fork it !
## Installation
1. Get [laravel](http://laravel.com/docs/5.2#installation) up and running
2. Add the following packages to your composer.json
```json
...
"laravelcollective/html": "5.2.*",
"yajra/laravel-datatables-oracle": "~6.0",
"mpaleo/view-tags": "~1.0",
"mpaleo/scaffolder-theme-material": "~1.0",
"mpaleo/scaffolder": "~2.0",
...
```
3. Update your packages
```bash
composer update
````
4. Add the service providers to the providers array in `{laravel-root}\config\app.php`
```php
...
ViewTags\ViewTagsServiceProvider::class,
ScaffolderTheme\ScaffolderThemeServiceProvider::class,
Scaffolder\ScaffolderServiceProvider::class,
Yajra\Datatables\DatatablesServiceProvider::class,
...
```
5. Add the following aliases in `{laravel-root}\config\app.php`
```php
...
'ViewTags' => ViewTags\ViewTags::class,
'Form' => Collective\Html\FormFacade::class,
'Html' => Collective\Html\HtmlFacade::class,
...
```
## Getting started
First you need to publish the configuration files and assets
```bash
./artisan vendor:publish --provider="Scaffolder\ScaffolderServiceProvider"
./artisan vendor:publish --provider="ScaffolderTheme\ScaffolderThemeServiceProvider" --force
```
Here we are using the theme [mpaleo/scaffolder-theme-material](https://github.com/mpaleo/scaffolder-theme-material), but you can fork it, and do whatever you want/need :)
At this point, you already can start to scaffold things. You have two ways to use the package.
##### Command line way
When you execute the artisan publish command, the service provider creates the folder `{laravel-root}\scaffolder-config` that has the following structure:
```
- scaffolder-config
-- app.json
-- models
-- cache
```
The `app.json` file contains global settings, also you will get some demo files for models. All you need to scaffold an application is to edit the `app.json` file, and create the json files for the models you want. After you have all the files ready, you have the following commands:
This command generate the application using the files that you have provided.
```bash
./artisan scaffolder:generate
```
For instance, when you update the package, you should clear the cache files stored in `{laravel-root}\scaffolder-config\cache`
```bash
./artisan scaffolder:cache-clear
```
##### User interface way
All you need to do, is go to your `http://{crazyhost}/scaffolder/generator` and fill some inputs :)
##### Next steps
- Run migrations `./artisan migrate`
- [Wiki](https://github.com/mpaleo/scaffolder/wiki)
- [API Docs](http://mpaleo.github.io/scaffolder/api)
## Contributing
Just let me know your ideas and let's work together
### Coding style
It would be great if we follow the PSR-2 coding standard and the PSR-4 autoloading standard.
### License
The scaffolder package is licensed under the [MIT license](http://opensource.org/licenses/MIT)