README

Curdder is a lightweight PHP CRUD generator.

It can:

• inspect an existing database schema
• generate a CRUD-ready config for a Laravel app
• accept explicit table and foreign-key join instructions
• provide a Laravel wizard for selecting tables, joins, and creating tables

Install

composer require curdder/curdder

Generate from a database

php vendor/bin/curdder generate \
  --dsn="mysql:host=127.0.0.1;dbname=app;charset=utf8mb4" \
  --user=root \
  --password=secret \
  --output=./storage/app \
  --mode=laravel

Limit tables

php vendor/bin/curdder generate \
  --dsn="sqlite:/path/to/database.sqlite" \
  --table=users \
  --table=posts \
  --output=./storage/app

Explicit joins

You can define joins when the database does not expose the relationship the way you want.

php vendor/bin/curdder generate \
  --dsn="mysql:host=127.0.0.1;dbname=app" \
  --join="posts.user_id=users.id:name" \
  --join="posts.category_id=categories.id:title"

Join rule format:

table.column=related_table.related_column:label_column

Spec file

Use a JSON or PHP spec file when you want to describe tables, labels, and relations in one place.

{
  "name": "Blog Admin",
  "tables": [
    "users",
    {
      "name": "posts",
      "label": "Posts",
      "search_columns": ["title", "slug"]
    }
  ],
  "relations": [
    {
      "table": "posts",
      "column": "user_id",
      "references": "users.id",
      "label_column": "name"
    }
  ]
}

Then run:

php vendor/bin/curdder generate \
  --dsn="mysql:host=127.0.0.1;dbname=app" \
  --spec=./crudder.json \
  --output=./storage/app

Use in Laravel

Install the package in your Laravel app and open:

• http://localhost:2222/crudder
• http://localhost:2222/crudder/tables/create

The package stores the generated config in storage/app/crudder.php by default.