Project structure

Where Nibiru puts things, and why. The shape on disk maps to the four MMVC roles — read top-down and the framework will explain itself.

A fresh Nibiru install is just a Composer-managed PHP project with a single CLI binary, an application/ tree for your code, and a core/ tree for the framework itself. Everything else — Smarty's compiled templates, the public docroot, the migrations history — falls out of those four conventions.

Overview

Open the repo and you'll see this:

# A Nibiru project, top level
my-app/
├── application/        // your code lives here
│   ├── controller/
│   ├── module/
│   ├── view/
│   └── settings/
├── core/               // the framework — don't edit
├── public/             // docroot — point your vhost here
├── nibiru              // the CLI binary
├── composer.json
└── index.php           // front controller

application/

Your code. Each role in MMVC is its own subdirectory: controller/, module/, view/. The fourth — Models — live inside their own module/<name>/models/ subtrees, because in MMVC every module owns the data shape it touches.

core/

The framework itself. Don't edit it. If you find yourself reaching in here, the answer is almost always to extend a class in application/ instead. The single exception: contributing back.

public/

Your vhost docroot. Static assets are served directly from this directory; everything else falls through to the front controller via index.php. The .htaccess in the project root takes care of rewrites for Apache; the included vhost.conf shows the equivalent for nginx.

Naming conventions

Every controller is <name>Controller.php, every module sits at application/module/<name>/, every Smarty template lives at application/view/templates/<name>.tpl. The CLI enforces this — you don't have to remember it.

Next

You know where things go. Now wire one up — the Quick start takes you from an empty project to a running controller in five commands.