Ecosyste.ms: Awesome

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

https://github.com/friendsofcake/crud

Production-grade rapid controller development with built in love for API and Search
https://github.com/friendsofcake/crud

cakephp cakephp-plugin crud php

Last synced: about 2 months ago
JSON representation

Production-grade rapid controller development with built in love for API and Search

Lists

README 

        
[![Build Status](https://img.shields.io/github/actions/workflow/status/FriendsOfCake/crud/ci.yml?branch=master&style=flat-square)](https://github.com/FriendsOfCake/crud/actions?query=workflow%3ACI+branch%3Amaster)

[![Coverage Status](https://img.shields.io/codecov/c/github/FriendsOfCake/crud.svg?style=flat-square)](https://codecov.io/github/FriendsOfCake/crud)

[![Total Downloads](https://img.shields.io/packagist/dt/FriendsOfCake/crud.svg?style=flat-square)](https://packagist.org/packages/FriendsOfCake/crud)

[![Latest Stable Version](https://img.shields.io/packagist/v/FriendsOfCake/crud.svg?style=flat-square)](https://packagist.org/packages/FriendsOfCake/crud)



# Installation



For CakePHP 4.x compatible version:



```

composer require friendsofcake/crud

```



For CakePHP 3.x compatible version:



```

composer require friendsofcake/crud:^5.0

```



For CakePHP 2.x compatible version:



```

composer require friendsofcake/crud:~3.0

```



# Introduction



Crud was built to be scaffolding on steroids, and allow developers to have

enough flexibility to use it for both rapid prototyping and production

applications, even on the same code base -- saving you time.



* Crud is [very fast to install](http://crud.readthedocs.org/en/latest/installation.html), a few minutes tops.



* Crud is very flexible and has tons of [configuration options](http://crud.readthedocs.org/en/latest/configuration.html).



* Crud aims to stay out of your way, and if it happens to get in your way, you can change the undesired

behavior very easily.



* Crud relies heavily on CakePHP events and is possible to override, extend, or disable almost all

of Crud's functionality either globally or for one specific action.



* Usually, the basic code for controller CRUD actions are very simple and always looks the same. Crud

will add the actions to your controller so you don't have to reimplement them over and over again.



* Crud does not have the same limitations as CakePHP's own scaffolding, which is "my way or the

highway." Crud allows you to hook into all stages of a request, only building the controller code

needed specifically for your business logic, outsourcing all the heavy boilerplating to Crud.



* Less boilerplate code means less code to maintain, and less code to spend time unit testing.



* Crud allows you to use your own views, baked or hand-crafted, in addition to adding the

code needed to fulfill your application logic, using [events](http://crud.readthedocs.org/en/latest/events.html). It is

by default compatible with CakePHP's baked views.



* Crud also provides built in features for JSON and XML [API](http://crud.readthedocs.org/en/latest/listeners/api.html)

for any action you have enabled through Crud, which eliminates maintaining both a

HTML frontend and a JSON and/or XML interface for your applications -- saving you tons of time and

having a leaner code base.



# Bugs



If you happen to stumble upon a bug, please feel free to create a pull request with a fix

(optionally with a test), and a description of the bug and how it was resolved.



You can also create an issue with a description to raise awareness of the bug.



# Features



If you have a good idea for a Crud feature, please join us on IRC/Slack in the #friendsofcake channel

and let's discuss it (this is not a support channel). Pull requests are always more than welcome.



# Support / Questions



You can use any of CakePHP's support forums/channels for any support or questions.