Search by

studoo / edu-framework-skeleton

bfoujols

Edu Framework Skeleton

Package info

github.com/studoo-app/edu-framework-skeleton

Language:Twig

Type:project

pkg:composer/studoo/edu-framework-skeleton

Statistics

Installs: 404

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v2.11.2 2026-11-07 13:19 UTC

This package is auto-updated.

Last update: 2026-11-16 22:24:48 UTC


README

Welcome to your project built with Edu Framework!

Documentation

The full documentation is available in English and French:

Requirements

  • PHP 8.4 or higher
  • Required PHP extensions: mbstring, pdo_sqlite, pdo_mysql, openssl
  • Optional PHP extension: excimer (code profiler of the debug bar, already installed in the Docker image)
  • Composer 2.x
  • Docker and Docker Compose

Check your setup with php bin/edu check:config.

Installation

  1. Clone the project

    git clone <your-repo>
    cd <your-project>
  2. Install the dependencies

    composer install
  3. Configure the environment

    composer edu:init   # copies .env.example to .env
    # Edit .env to suit your needs (APP_ENV=dev for the debug bar)
  4. Start the application, either:

    • Everything in Docker (application served by FrankenPHP)

      docker compose up -d --build

      The application is available at http://localhost (port HTTP_PORT).

    • Services in Docker, application on your computer

      docker compose up -d database mailer dbgate phpmyadmin redis redisinsight
      php bin/edu start

      The application is available at http://localhost:8042.

The guide The application in Docker describes both modes in detail.

Available services

Service Port (default) .env variable Description
FrankenPHP 80 / 443 HTTP_PORT / HTTPS_PORT Web server (PHP + Caddy, HTTPS and HTTP/3)
MariaDB 3306 DB_SOCKET Database
phpMyAdmin 8081 PMA_PORT MariaDB administration
dbgate 8082 DBGATE_PORT Database administration (MariaDB and the SQLite logs database)
Mailpit 1025 (SMTP), 8025 (Web) MAILER_SMTP_PORT / MAILER_UI_PORT Email testing
Redis 6379 REDIS_PORT Application cache server (used with CACHE_DRIVER=redis)
Redis Insight 5540 REDIS_UI_PORT Web interface to explore the Redis cache keys
Built-in server 8042 — php bin/edu start (outside Docker)

The application cache uses files by default (CACHE_DRIVER=file): set CACHE_DRIVER=redis in the .env file to use the Redis service, see the tutorial Caching data with Redis.

Container names are prefixed with APP_NAME. If another project already uses these ports, change them in the .env file.

HTTPS

The FrankenPHP server is driven by the SERVER_NAME variable:

  • :80: plain HTTP (default, development)
  • localhost: local HTTPS with a self-signed certificate (https://localhost)
  • my-site.com: HTTPS with Let's Encrypt (production, public domain required)

Debug bar and profiler

In development mode (APP_ENV=dev), a debug bar is displayed at the bottom of every page and the profiler is available at /_debug/profiler:

  • log of every HTTP request (status, duration, memory, SAPI, errors), stored in var/logs/core_logs.sqlite
  • SQL queries run by each HTTP request (duration, repeated queries)
  • application cache operations (hits, misses, writes) when the page uses the cache
  • links to the development services (Mailpit, dbgate, phpMyAdmin, Redis Insight)
  • code profiler (Excimer extension): time spent in each PHP function, Speedscope export for a flame graph

Code profiler settings in the .env file:

Variable Values Description
EDU_PROFILER off, trigger (default), on trigger: on-demand profiling with the Code button of the debug bar or ?_profile=1; on: every request is profiled
EDU_PROFILER_KEEP 50 Number of profiles kept
EDU_PROFILER_BUILD 1 (default), 0 Docker image with or without Excimer

See The debug bar and the profiler.

Unit tests

PHPUnit is already installed and configured (phpunit.xml, tests/bootstrap.php): write your tests in the tests folder and run them with vendor/bin/phpunit.

See Test your application (unit tests).

Useful commands

  • Start the built-in server: php bin/edu start --port=8080
  • Check the configuration: php bin/edu check:config (in Docker: docker compose exec frankenphp php bin/edu check:config)
  • Show the version: php bin/edu --version
  • Generate a controller: php bin/edu make:controller NameController
  • Generate a CLI command: php bin/edu make:command name:command
  • Generate an API: php bin/edu make:api NameApi
  • Run the tests: vendor/bin/phpunit

Migration

Contributing

To contribute to the project, read the contribution guide.

License

MIT License - Copyright (c) 2022-2026 Collectif Studoo