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

Project structure

nevela new my-app gives you two apps in one folder.

my-app/
├─ apps/
│ ├─ api/ the Laravel app
│ └─ web/ the Next.js dashboard
├─ nevela the app's own launcher: php nevela does what nevela does
└─ package.json

nevela new my-app --mobile adds a third, apps/mobile: the mobile app.

An ordinary Laravel app. These are the parts Nevela adds to it:

Path What it holds
nevela/resources/*.json One descriptor per resource. The input to everything else.
app/Models/ A model per resource.
app/Http/Requests/Nevela/ Validation per resource.
app/Http/Resources/Nevela/ The shape of a record in the API.
app/Http/Controllers/Api/ A controller per resource.
app/Policies/ Authorization per resource. Written once, then yours.
routes/nevela.php The resource routes. Add your own below the generated block.
routes/nevela-public.php The routes anyone may call without signing in, for resources with a public side.
app/Nevela/Actions/<Resource>/ A class per action, where you write what it does. Written once, then yours.
database/migrations/ The create-table migration per resource. Written once, then yours.
Path What it holds
resources/ The dashboard’s description of each resource, generated from Laravel.
app/dashboard/<slug>/ The list, new, detail and edit pages per resource. Written once, then yours.
app/dashboard/ Also the pages every app has: the home page, your account, users and roles, the trash and the activity log.
app/sign-in/, app/sign-up/, … Signing in, signing up, a forgotten password, two-factor and verifying an address.
app/page.tsx, app/blog/ The public site: its home page and the blog.
lib/laravel.ts The one place that calls Laravel.
lib/site.ts The app’s name, text and theme.
components/ The tables, forms and fields.
policies/ Optional: hide buttons by role.
.env.local NEVELA_API_URL, the address of the Laravel API, and the other settings.
.nevela.json The dashboard version the app is on, a fingerprint of every file in it, and the history of updates. It is how an update knows which files you changed. Commit it.
.nevela/ Backups of files an update replaced, and new versions of files you had changed. It ignores itself in git. Appears after the first update.

See The web app for how these fit together.

The generator, the commands and the code behind the REST API are a Composer package, nevela/laravel. It is installed into apps/api/vendor like any other dependency, and updated the same way:

Terminal window
nevela upgrade

That also updates the dashboard files you have not changed. See Updating.

If your app has a packages/nevela-laravel folder instead, it was created with --bundled-package, or before a matching release existed. Composer installs the package from that folder. Treat it as a dependency and don’t edit it.

There is no routes/api.php. Nevela registers its own routes under /api, from routes/nevela.php, so the app does not need one. If you want Laravel’s usual API routes file as well, run php artisan install:api; the two work side by side.

File What it does
nevela The app’s own launcher, for anyone without the nevela command installed: php nevela resource …, php nevela upgrade and the rest, without cd apps/api. See Commands.
package.json Shortcuts for people who prefer their package manager: pnpm dev is nevela dev, and pnpm nevela <command> is nevela <command>.
.gitignore Keeps vendor, node_modules, .env files and build output out of git.
You want to Put it
Add a scope, an accessor or a relationship of your own In the model, outside the generated block
Change who may do what In the policy
Change a column after it is made In a new migration
Add an API endpoint In routes/nevela.php, below the generated block
Change a dashboard page’s layout In the page under app/dashboard/<slug>/
Add a field nevela field Product weight:float
Change a field’s type In the descriptor JSON, then run nevela generate

Regeneration and your code explains what is and is not rewritten.