Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/junaidqadirb/cray

A Laravel package to help you generate nearly complete CRUD pages like crazy!
https://github.com/junaidqadirb/cray

crud generator laravel laravel-package php scaffolder

Last synced: 4 days ago
JSON representation

A Laravel package to help you generate nearly complete CRUD pages like crazy!

Host: GitHub
URL: https://github.com/junaidqadirb/cray
Owner: JunaidQadirB
License: mit
Created: 2019-12-01T06:39:46.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2023-12-26T08:17:58.000Z (12 months ago)
Last Synced: 2024-10-12T06:47:14.524Z (2 months ago)
Topics: crud, generator, laravel, laravel-package, php, scaffolder
Language: PHP
Homepage:
Size: 265 KB
Stars: 240
Watchers: 11
Forks: 17
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Cray For Laravel
[![Latest Stable Version](http://poser.pugx.org/jq/cray/v)](https://packagist.org/packages/jq/cray)
[![Latest Unstable Version](http://poser.pugx.org/jq/cray/v/unstable)](https://packagist.org/packages/jq/cray)
[![Daily Downloads](http://poser.pugx.org/jq/cray/d/daily)](https://packagist.org/packages/jq/cray)
[![Total Downloads](http://poser.pugx.org/jq/cray/downloads)](https://packagist.org/packages/jq/cray)
[![Quality Score](https://img.shields.io/scrutinizer/g/junaidqadirb/cray.svg?style=flat-square)](https://scrutinizer-ci.com/g/junaidqadirb/cray)
[![License](http://poser.pugx.org/jq/cray/license)](https://packagist.org/packages/jq/cray)
[![PHP Version Require](http://poser.pugx.org/jq/cray/require/php)](https://packagist.org/packages/jq/cray)

## What is Cray?

Cray is a `disposable` Laravel package to help you generate nearly complete CRUD pages like crazy. Literally. It's also a bit opinionated.

If you build straight-forward CRUD pages more often manually writing all the same logic becomes a chore. Cray will not only save you a save but also give you a better way to organize your code.

## So what do you mean by disposable?

You use Cray and forget about it. It isn't coupled with your installation of Laravel and it is preferred to be installed as a `dev` dependency. Cray generates the files and it forgets about them and they are all yours to modify do whatever you want.

## What does it actually do?

Suppose you are building a blog, and you want to create a Post model then you have to do a ton of other tedious and to be honest, boring things like creating migrations, model factories, the controller, form validation and adding all the logic and what not.

So what Cray does is when you tell it the model name, it will do all those boring things I listed earlier. When it's done you have the following:

- `Post.php`
- `PostController.php` with all the necessary logic to list, edit, create and delete posts.
- `PostStoreRequest.php` and `PostUpdateRequest.php`
- Timestamped `create_posts_table.php` migration file
- `PostFactory.php`
- `posts` views directory with `index.blade.php`, `create.blade.php`, `edit.blade.php`, `show.blade.php`, `modals/delete.blade.php`as well as a blank `_form.blade.php` for you to add the fields.

Then all you have to do is:

- Add the columns to the migration file
- Add the necessary fields (as defined in the last step) to the `_form.blade.php`
- Add validation rules for the fields you added to the form.

## Installation

```bash
composer require jq/cray --dev
```
Or specify specific version, for example to try a beta

```bash
composer require "jq/cray:3.2.0-beta3" --dev
```

Then publish the stubs

```bash
php artisan vendor:publish --tag=cray
```

It will generate `stubs` to `resources/vendor/cray/stubs` directory.

## Usage

```bash
php artisan cray Post
```

Once done, it will show you the details of the files generated.

```bash
Factory created successfully in /database/factories/PostFactory.php
Created Migration: 2020_03_14_151409_create_posts_table
Model created successfully in /app/Post.php
Controller created successfully in /app/Http/Controllers/PostController.php
View created successfully in /resources/views/posts/index.blade.php
View created successfully in /resources/views/posts/create.blade.php
View created successfully in /resources/views/posts/_form.blade.php
View created successfully in /resources/views/posts/edit.blade.php
View created successfully in /resources/views/posts/show.blade.php
View created successfully in /resources/views/posts/modals/delete.blade.php
Request created successfully in /app/Http/Requests/PostStoreRequest.php
Request created successfully in /app/Http/Requests/PostUpdateRequest.php
```

Now add the necessary fields and run

```bash
php artisan migrate
```

And that saved you an hour worth of repetitive and boring work which you can spend on more important development challenges.

### Optional Packages
- [Blade Components](https://github.com/JunaidQadirB/blade-components)

## Documentation
You can read the documentation [here](https://junaidqadirb.github.io/cray/).

### Changelog

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

- [Laravel](https://github.com/laravel)
- [Junaid Qadir](https://github.com/junaidqadirb)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

## Laravel Package Boilerplate

This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).