dejwcake/admin-generator

Laravel CRUD generator for dejwcake/craftable

Installs: 185

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 39

Type:project

1.0.1 2025-03-04 21:17 UTC

This package is auto-updated.

Last update: 2025-03-04 21:31:02 UTC


README

Admin Generator is a package that helps you quickly scaffold your typical CRUD admin interfaces. It generates the code based on the existing (migrated) table in the database. It uses an admin UI template from our other package brackets/admin-ui.

Example of an administration interface generated with this package: Craftable administration area example

This packages is part of Craftable (brackets/craftable) - an administration starter kit for Laravel 8. You should definitely have a look :)

Documentation

You can find full documentation at https://docs.getcraftable.com/#/admin-generator

Composer

To develop this package, you need to have composer installed. To run composer command use:

  docker compose run -it --rm test composer update

For composer normalization:

  docker compose run -it --rm php-qa composer normalize

Run tests

To run tests use this docker environment.

  docker compose run -it --rm test vendor/bin/phpunit -d pcov.enabled=1

To regenerate snapshots use

  docker compose run -it --rm test vendor/bin/phpunit -d pcov.enabled=1 -d --update-snapshots

To switch between postgresql and mariadb change in docker-compose.yml DB_CONNECTION environmental variable:

- DB_CONNECTION: pgsql
+ DB_CONNECTION: mysql

Run code analysis tools

To be sure, that your code is clean, you can run code analysis tools. To do this, run:

For php compatibility:

  docker compose run -it --rm php-qa phpcs --standard=.phpcs.compatibility.xml --cache=.phpcs.cache

For code style:

  docker compose run -it --rm php-qa phpcs -s --colors --extensions=php

or to fix issues:

  docker compose run -it --rm php-qa phpcbf -s --colors --extensions=php

For static analysis:

  docker compose run -it --rm php-qa phpstan analyse --configuration=phpstan.neon

For mess detector:

  docker compose run -it --rm php-qa phpmd ./src,./tests ansi phpmd.xml --suffixes php --baseline-file phpmd.baseline.xml

Issues

Where do I report issues? If something is not working as expected, please open an issue in the main repository https://github.com/BRACKETS-by-TRIAD/craftable.