README.md

AdminGenerator

1. Quick tour:

This bundle helps you quickly create powerful CRUD backend. Customizing the standard functionalities is simple - you can easily overwrite any part of the generated code. Most features can be configured in one (per model) YAML file. Advanced examples are covered in our cookbook, accessible through our documentation. For a quick preview visit our demo project.

2. Highlights:

• one command to generate full CRUD for a model
• one configuration file (per model) to customize your backend
• supports popular model managers: Doctrine ORM, Doctrine ODM and Propel
• admin design based on AdminLTE v2
• active community, support on Gitter Chat

3. Features:

List view:

• sorting
• pagination
• filters
• scopes
• button links to object actions
• check rows to select and perform batch actions

Nestedset List view:

• drag & drop to manage your tree

New / Edit form:

• group fields in fieldsets
• group fieldsets in tabs
• dedicated bundle with additional form types
• add/remove fields to the form based on credential checks
• display errors next to fields when form is invalid
• display error count for each tab
• (optional) help blocks
• button links to object actions

Show view:

• add/remove displayed fields based on credential checks
• button links to object actions

4. Documentation

The documentation for this bundle can be found in Resources/doc directory.

5. Community and support

If you're having trouble or you found an error feel free to open a github ticket, but first please read submitting issues. You can also find help on our chat. If you like this bundle join our SensioConnect club, follow us on Twitter and recommend us on KnpBundles.

6. Versioning

Releases will be numbered with the format major.minor.patch.

And constructed with the following guidelines.

• Breaking backwards compatibility bumps the major.
• New additions without breaking backwards compatibility bumps the minor.
• Bug fixes and misc changes bump the patch.

For more information on SemVer, please visit semver.org website.

When upgrading the to the newest build, always check our upgrade notes.

7. Contributing

This bundle follows branching model described in A successful git branching model blog post by Vincent Driessen.

• The master branch is used to tag stable releases.
• The develop branch is used to develop small changes and merge feature branches into it.
• The feature- branches are used to develop features. When ready, submit a PR to develop branch.
• The hotfixes branch is used to develop fixes to severe bugs in stable releases. When ready, the fix is merged both to develop and master branches.
• The release branches (eg. 1.1) are created for each minor release and only patches will be merged into them.

8. This bundle in pictures

By default, this Bundle uses the AdminLTE templates. See its documentation to create your own widget and customize the interface.

9. License

This bundle is released under the MIT License except for the file: Resources/doc/img/branching-model.png by Vincent Driessen, which is released under Creative Commons BY-SA.