Skip to main content

Gluo Core

The Gluo framework core — the glue ("gluo" is Esperanto for glue) that binds the byjg components into a REST architecture.

Sponsor Build Status Opensource ByJG Install MCP Server GitHub source GitHub license GitHub release

You normally don't install this package directly. Start a project with the byjg/gluo starter instead:

composer create-project byjg/gluo my-api

The starter generates a project you fully own; byjg/gluo-core stays in vendor/ and framework improvements arrive with a plain composer update.

What's inside​

  • Base classes — BaseLoginController, BaseRepository, BaseService, BaseUser, BaseUserProperties, BaseConfigBootstrap
  • Attributes — RequireAuthenticated, RequireRole, ValidateRequest
  • Utilities — JwtContext, OpenApiContext, FakeApiRequester, OrderBy
  • Builder — BaseScripts: database migration entry points, OpenAPI generation, and the code generator (./gluo codegen:*) with its Jinja templates
  • Console — Launcher, the ./gluo command line (built-in and project commands), and Checker, the built-in rows of ./gluo list --check
  • Test harness — BaseApiTestCase for contract-testing your REST endpoints against the OpenAPI definition
  • Traits — OaCreatedAt, OaUpdatedAt, OaDeletedAt

Installation​

composer require byjg/gluo-core

Documentation​

The full documentation (getting started, guides, and reference) lives in the byjg/gluo starter repository.

Running Tests​

composer install
vendor/bin/phpunit

Open source ByJG