crudify/example.yaml at main · devalade/crudify · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# CRUDify YAML Configuration Example
# Generate with: php artisan crudify:generate --file=example.yaml
# Includes belongsToMany example with auto-generated pivot migration.

model: Post

fields:
  # Simple fields
  title:
    type: string
    nullable: false
    unique: true

  slug:
    type: string
    nullable: false
    unique: true
    index: true

  body:
    type: text
    nullable: false

  excerpt:
    type: text
    nullable: true

  # Boolean with default
  is_published:
    type: boolean
    default: false

  # DateTime field
  published_at:
    type: datetime
    nullable: true

  # Numeric fields
  view_count:
    type: integer
    nullable: true
    default: 0

  rating:
    type: decimal
    nullable: true

  # Single image upload
  featured_image:
    type: image
    nullable: true

  # Single file upload
  attachment:
    type: file
    nullable: true

  # Multiple image uploads
  gallery:
    type: image
    multiple: true
    nullable: true

  # Multiple file uploads
  documents:
    type: file
    multiple: true
    nullable: true

  # Foreign key field (legacy style, prefer relationships section)
  # author_id:
  #   type: foreign
  #   foreign: users
  #   nullable: false

# Relationships define model methods and form fields
# Supported types: belongsTo, hasMany, hasOne, belongsToMany
relationships:
  # One-to-Many (inverse) - generates dropdown in forms
  user:
    type: belongsTo
    model: User

  category:
    type: belongsTo
    model: Category

  # Many-to-Many - generates checkbox group in forms
  # Also generates post_tag pivot migration and Tag model if missing
  tags:
    type: belongsToMany
    model: Tag

  # One-to-Many - generates model method only (no form field)
  comments:
    type: hasMany
    model: Comment

# Searchable fields for the index table
searchable:
  - title
  - body

options:
  soft_deletes: false