README

The official project template for PHP Simple Framework. Bootstrap a full working application in one command.

Package: nations-original/php-simple-framework-template License: ISC Author: Dmytro Dyvulskyi — CEO & Lead Developer, Nations Original

Documentation

Full documentation is available at wiki.nations-original.com/framework.

Requirements

Required:

• PHP 8.3+ with extensions: apcu, curl, gd, intl, redis, yaml, opcache
• Composer 2.x
• Node.js 18+ with yarn
• Redis (routing cache and application cache)
• At least one database: PostgreSQL 15+ / MySQL / MariaDB

Optional:

• ext-amqp + RabbitMQ — only if you use message queues
• ext-memcached — only if you use Memcached as a cache backend
• Docker — docker-compose.yml provided for all services
• Symfony CLI — used by run.sh for HTTPS local dev

Installation

composer create-project nations-original/php-simple-framework-template my-app
cd my-app
./init.sh

init.sh runs once per project — it configures database connections, generates .env and config/constants.php, creates entity/repository directories, and builds frontend assets.

For subsequent machines cloning an already-configured project:

./install.sh

Full setup details: Installation guide.

Project Structure

App/
├── Http/
│   ├── Controller/          # PHP_SF attribute-routed controllers
│   ├── SymfonyControllers/  # Native Symfony controllers (fallback)
│   └── Middleware/          # Custom middleware
├── Entity/                  # Doctrine entities, created by init.sh per connection
├── Repository/              # Entity repositories, created by init.sh per connection
├── DataFixtures/            # Doctrine fixtures (per connection)
├── Enums/                   # Application enums
├── DoctrineLifecycleCallbacks/
└── Kernel.php               # App kernel (extends Symfony Kernel)
config/
├── constants.php            # App-level constants (not committed — copy from .example)
├── packages/                # Symfony bundle config (doctrine, messenger, cache, …)
└── routes.yaml              # Symfony controller route import
templates/                   # PHP view classes (App\View\ namespace)
lang/                        # Translation files
public/                      # Web root

Database Setup

The template ships with only a dummy (default) entity manager that fails fast to prevent accidental cross-DB access. init.sh adds your real connections interactively — you can configure one or more, with any supported engine.

Once configured, the standard Doctrine commands work per-connection using --em=<name>:

bin/console doctrine:database:create --if-not-exists --em=<name>
bin/console doctrine:schema:create --em=<name>
bin/console doctrine:fixtures:load --no-interaction --em=<name>

At minimum you need one connection and one User entity (also generated by init.sh) — the framework requires it for authentication and session handling.

Development

./run.sh              # Start dev server on port 7000 (uses Symfony CLI if available)
bin/console           # Symfony console
npm run dev           # Frontend dev build with watch
npm run build         # Frontend production build
docker-compose up -d  # Start all infrastructure services

Infrastructure services (Docker)

Full reference: Docker & Local Environment.

Testing

Tests are written with Codeception (Unit, Functional, Acceptance suites).

vendor/bin/codecept run            # Run all suites
vendor/bin/codecept run Functional # Run specific suite

Full reference: Codeception.

License

ISC — see LICENSE.MD.