README

SimpleRest is a PHP framework for building HTTP applications and REST APIs. This repository contains the framework source, an application bootstrap, configuration and routing files, a command-line entry point, tests, examples, and locally developed packages.

The framework has its own runtime and conventions. Its behavior is defined by the code in this repository; similarities to other PHP frameworks are not a substitute for the SimpleRest API or architecture.

Repository at a glance

• src/framework/ — framework classes, including the HTTP and CLI routers, request pipeline, API base classes, database utilities, and other core components.
• app/ — application controllers, models, commands, schemas, views, and modules used by this checkout.
• config/ — application configuration and route registration.
• database/ — database migration files used by this application.
• unit-tests/ — repository test files; this directory is not listed in the current phpunit.xml test suites.
• examples/ — example code.
• packages/ — packages maintained in this repository.
• docs/ — topic documentation and the documentation audit record.

index.php loads app.php, then checks the web router, CLI router, and front controller in config/config.php order. A web route that matches and dispatches exits before later stages. The front controller builds its request-processing handlers from front_behaviors. See Architecture for the evidence-backed overview.

Requirements

The current composer.json declares PHP >=8.1,<8.5. It also declares Composer dependencies. Database drivers, database setup, web-server configuration, and optional integrations depend on which features an application uses; consult the relevant guide before deployment.

Getting started

This checkout is an application repository as well as framework source. Composer metadata describes the package as boctulus/simplerest of type library; that fact alone does not establish that a clean consumer project can install and run the framework as a standalone application. The installation and clean-start guide is being reconstructed and must be verified from a clean environment before it is treated as a copy-and-run tutorial.

Start with the documentation map and documentation status and evidence rules. The existing topic files are being audited against source and tests; until that audit is complete, use them as material to review, not as authoritative specifications.

Development checks

The Composer manifest currently defines these scripts:

composer test
composer cs

composer test invokes phpunit --colors=always. The current phpunit.xml points to tests/ and packages/boctulus/friendlypos-web/tests; the root tests/ directory is absent and unit-tests/ is not configured as a suite. Whether the command runs successfully or discovers the intended repository tests has not been verified. composer cs invokes PHPStan against src at level 7.

Contributing

See CONTRIBUTING.md.

License

SimpleRest is distributed under the MIT License. See LICENSE.