README

A PHP 8.5+ / React 19 application framework that ships with its tooling. Install it, don't fork it: the framework arrives through Composer and npm, your project keeps its own namespace and git history, and uBixVault holds its secrets.

One v* tag publishes all three with the same version. License: BSD-3-Clause.

Start a project

composer create-project ubixsys/ubixcore-skeleton acme
cd acme
php bin/ubix list                                     # the framework's commands, plus yours
APP_NAME=HelloApi php -S 127.0.0.1:8080 -t public     # curl /health
php bin/ubix code:review                              # phpcs · phpstan (level max) · phpunit

The skeleton's README.md is the developer quickstart; its docs/ci-setup.md is the operator's checklist for a green pipeline (runner, registry access, CI variables, uBixVault secrets, Kubernetes prerequisites). The full write-up, including a worked installation scenario, is on ubixsys.com.

Working on the framework

Requirements: PHP 8.5+, Composer 2, Node 22+ (for ts/Ubix), a MariaDB reachable for the SQL-layer tests (CI uses sql/ubixcore_test.sql rebuilt by database:resetSchema test).

composer install
git config core.hooksPath .githooks   # pre-push gate: bin/ubix code:review --phpunit=off
cp .env.example .env                  # optional for local dev; CI and containers take their environment from uBixVault / the pod spec

vendor/bin/phpunit                    # framework tests
vendor/bin/phpstan                    # level max, bleeding edge
vendor/bin/phpcs                      # the Ubix standard
bin/ubix code:review                  # all three as one gate

cd ts/Ubix && npm install && npm run build     # the React library (tsup -> dist/)

Layout:

php/Ubix/          the framework — Bootstrap/, Console/, Controller/, Middleware/, Repository/,
                   DataType/, Model/, Payload/, Service/, Tests/ (shipped PHPUnit bases),
                   ruleset.xml + Sniffs/ (the Ubix phpcs standard), phpstan.neon (baseline)
skeleton/          the create-project template, published by the tag pipeline
ts/Ubix/           @ubixsys/ubixcore
tests/             framework tests, mirroring php/Ubix/
sql/               ubixcore_test.sql (CI fixture) + the tracker's init migration
docs/standards/    the house standards hosts inherit
docs/projects/     how this repo became a framework + skeleton (ubixcore-oss/)
bin/ubix · public/index.php   thin entry points, same shape as the skeleton's

Ubix\ is reserved for the framework; product code never lives here. Products built on uBixCore live in their own host repos generated from the skeleton.

Releasing

Tag main: git tag -a v0.3.1 && git push origin v0.3.1. The tag pipeline publishes the framework and the npm package from this project's registries and subtree-splits skeleton/ into ubixsys/ubixcore-skeleton. Hosts upgrade with composer update ubixsys/ubixcore and commit the lock.

Coordination

Several agent sessions may work this repo at once. Register a lane in AGENTS-COORD.md (copied from the template) before branching; main is the trunk and is MR-only. Full rules in docs/standards/branching-and-git-workflow.md.