README

Single-app Pinoox project for Pinoox. Your project root is the app — no apps/ folder, no manager.

Quick start

composer create-project pinoox/app my-shop
cd my-shop
cp .env.example .env
pinx setup
pinx dev

The template ships with default identity com_pinoox_app / Pinoox App so it runs immediately after install. To use your own package name, run pinx init --package=com_vendor_app --force or edit app.php, platform/, namespaces under Controller/ / Router/, and routes/.

Or with global pinx CLI:

composer global require pinoox/pinx-cli
pinx new my-shop --package=com_acme_shop

Commands

Command	Description
`pinx setup`	Migrate platform + app, run seeders
`pinx dev`	Local HTTP server (and Vite when configured)
`pinx migrate`	App migrations
`pinx build`	Build `export/*.pinx` for platform install
`pinx release`	Bump version + build signed-ready package
`pinx doctor`	Check PHP, paths, and layout

Layout

my-shop/
├── app.php              ← package name & pinx settings
├── Controller/ Model/ routes/ theme/
├── resource/            ← app icon & static assets (default icon included)
├── platform/            ← local host + deploy layer (excluded from .pinx build)
│   ├── apps.config.php
│   ├── app-router.config.php
│   ├── domain.config.php
│   ├── pinoox.config.php
│   └── launcher/        ← bootstrap + dev server router
├── config/              ← app-level config only (app.config.php, services, …)
├── bin/pinx
└── vendor/pinoox/pincore

Config layers (do not mix)

Layer	Path	Examples
Pincore (framework)	`vendor/pinoox/pincore/config/`	database, paths — read-only
Project deploy + dev host	`platform/`	`apps.config.php`, `app-router.config.php`, `domain.config.php`, `launcher/`
Your app	`config/`	`app.config.php`, `query_route.config.php`, custom `*.config.php`

platform/ is not included in pinx build output — it is only for local development and routing on a single-app checkout. Production installs use the full Pinoox platform's own config.

PINOOX_PROJECT_CONFIG_PATH=platform in .env points pincore at this folder (default when platform/ exists).

Deploy to production platform

pinx build or pinx release --sign
Upload the .pinx file to a full Pinoox installation
Install via Manager → Applications

pinx build packages your app for installation on a full Pinoox platform. It applies system defaults automatically (excludes vendor/, bin/, .env, dev tooling, …) and bundles only third-party Composer requires when present. Override in app.php only when needed:

'build' => [
    'exclude' => ['my-private-notes/'],  // extra paths only
    'composer' => false,                 // opt out of composer bundling
],

Monorepo development

When working inside the pinoox/pinoox repository:

cd packages/app
composer config repositories.pinx-cli path ../pinx-cli
composer require pinoox/pinx-cli:@dev

pinoox / app

Maintainers

Package info

Statistics

Security