Skip to content
Nevela 0.33.1: New: customers get a shop in the mobile app, each sees only their own orders, and an administrator manages people and roles from the phone. Build it in the new drinks-app tutorial.A drinks app on the phone

The resource descriptor

nevela:resource writes a JSON file per resource in nevela/resources/. This file is the single source: everything else is generated from it.

{
"name": "Product",
"table": "products",
"slug": "products",
"label": "Product",
"pluralLabel": "Products",
"icon": "package",
"group": "Catalogue",
"fields": {
"name": { "kind": "string" },
"sku": { "kind": "string", "unique": true },
"price": { "kind": "float", "format": "money" },
"kind": { "kind": "enum", "options": ["stock", "digital"] },
"notes": { "kind": "text", "required": false }
}
}
Key Meaning
name The PascalCase name. Model, controller and policy are named from it.
table The database table.
id What a record’s id is: "int" for the numbered ids of $table->id(). Left out, ids are UUIDs. Set when the resource is made, with --id=int or by adopting a table.
adopted true for a table that was there before Nevela: no migration is written to create it.
slug The URL segment: /api/products and /dashboard/products.
label, pluralLabel What the dashboard calls one record and many.
icon A Lucide icon name for the sidebar, such as users, building-2 or graduation-cap. The dashboard knows the ones in apps/web/components/dashboard/resource-icon.tsx; add another there, and an icon it doesn’t know is a plain page. Optional.
group The sidebar heading the resource sits under. Optional.
titleField The field shown as a record’s title. Defaults to the first string field.
fields The fields, in the order they appear in forms and tables.
publish The optional date-and-time field a record is published by: empty is a draft, a time still to come is scheduled. See The blog. Optional.
blog Where on the site the resource’s public records are a blog ("/blog"). Written by nevela blog. Optional.
public What of the resource anyone may read or create without signing in. Nothing, without it. See A public site on your API, and Protecting a public form for its protect and confirm. Optional.
items The resource its lines are, such as "OrderItem": edited in its form as a table and saved with it. That resource has a belongsTo pointing here. See Line items. Optional.
unique Fields whose values go together once only, as lists of field names: [["studentId", "courseId"]] is one enrolment for each student and course. See Many-to-many. Optional.
actions What can be done to a record, or to the list, beyond create, edit and delete. See Actions on a record. Optional.

Each field has a kind (string, text, int, float, boolean, date, datetime, enum, belongsTo or file) and may have:

Key Meaning
format For strings: email, url, tel, slug, color. For numbers: money, percent, rating. For text: rich, which is rich text.
country For tel: the country its numbers are of, "UG". See Phone numbers.
target For belongsTo: the resource it points at, "Category". The field’s name ends in Id. See Relationships.
accept For a file: the kinds it takes, ["image"] or ["pdf", "document"]. See Files and images.
profile For an image: the profile it is optimised with, "product".
options The allowed values of an enum.
optionLabels For an enum: what each value is called where people read it, { "asap": "As soon as possible" }. See What an enum’s values are called.
currency For money: the ISO 4217 code it is in, "UGX". The app’s NEVELA_CURRENCY unless set. See Money and its currency.
private For a file: true keeps it where only someone who may view the record can fetch it. See private files.
multiple For a file: true holds several, up to 20, as a list of keys. See Several files in one field.
maxLength For string and text: the most characters it holds, where that isn’t the usual 255 or 65,535.
required false makes the field optional. Defaults to true.
unique true makes values unique. Defaults to false.
from For a slug: the field it is made from when a create leaves it empty ("title"). It is never remade afterwards. For any other field: the field of a related record it is copied from, "productId.price". See Copied from a related record.
auto For a string: the prefix of the number Laravel gives each new record, "INV" for INV-0001. Makes it unique. See Numbered by Laravel.
when The value of another field it applies for, { "kind": "recurring" }, or several in a list. Elsewhere it is empty. See A field that only sometimes applies.
default What the field is when a create leaves it out: "pending", 0, false. Also the column’s default. For string, text, int, float, boolean and enum.
label The label in the dashboard. Defaults to the field name in words.
list Its column in the dashboard’s table: true always on, "hidden" off until turned on in the Columns menu, false none. Left out, the first six columns are on, and long text and files start off. See Which columns the table shows.