README

EN

Joke — это учебный микрофреймворк с ручной маршрутизацией и встроенным DI-контейнером. Он разрабатывается в рамках образовательного челленджа и не претендует на конкуренцию с промышленными решениями, такими как Laravel или Symfony.

Несмотря на скромный функционал, реализуемые компоненты стремятся быть надёжными, тестируемыми и пригодными для использования в реальных проектах — в том числе в обучающих или прототипных задачах.

По условиям челенджа: не использовать существующие решения (кромe composer, PHPUnit, voral/version-increment)

Требования

• PHP 8.4+
• Composer

Реализованная функциональность

• Ручная маршрутизация HTTP-запросов
• DI-контейнер с поддержкой автовайринга параметров
• Система middleware (блокирующие и неблокирующие)
• Управление сессиями (включая поддержку «неблокирующего» режима — данные сессии считываются в начале обработки запроса, после чего сессия немедленно закрывается, позволяя другим запросам от того же пользователя работать параллельно без ожидания завершения текущего.)
• Обработка ошибок и исключений

Как начать

Самый простой способ начать — использовать официальный скелетон:

composer create-project voral/joke-minimal my-app
cd my-app
composer run dev

Приложение будет доступно по адресу: http://localhost:8000

Документация

Документация по фреймворку размещена здесь

Основные этапы челенджа

• Создание фреймворка
  • Реализация маршрутизации
  • Реализация сервисный контейнер
  • Консольная система команд
  • Авторизация
  • Валидация данных
  • Обработка ошибок
  • Логирование
  • Создание построителя SQL запросов
  • Миграции
  • Настраиваемое окружение через .env файл
• Создание шаблонизатора
  • Создание базового шаблонизатора HTML
  • Рендер Markdown файлов для быстрого создания документационных сайтов из .md файлов.
  • Рендер Swagger yaml файлов для автоматического отображения OpenAPI-спецификаций без внешних UI (например, без Swagger UI)
• Создание приложения форума
• Создание скелетонов
  • REST API приложения
  • Приложения веб представления Markdown файлов

Joke — A Micro Framework for PHP

Joke is an educational microframework featuring manual routing and a built-in DI container. It is developed as part of a learning challenge and is not intended to compete with production-grade frameworks like Laravel or Symfony.

Despite its limited scope, the implemented components aim to be reliable, testable, and suitable for real-world use—even in educational or prototyping scenarios.

As per the challenge rules, no existing solutions may be used except for Composer, PHPUnit, and voral/version-increment.

Requirements

• PHP 8.4+
• Composer

Implemented Features

• Manual HTTP request routing
• DI container with automatic parameter wiring
• Middleware system (blocking and non-blocking)
• Session management, including non-blocking mode — session data is read at the beginning of request processing and the session is immediately closed, allowing concurrent requests from the same user to proceed without waiting for the current request to finish
• Error and exception handling

Getting Started

The easiest way to get started is to use the official skeleton:

composer create-project voral/joke-minimal my-app
cd my-app
composer run dev

Your application will be available at: http://localhost:8000

Challenge Roadmap

• Framework Core

  • Implement routing
  • Implement service container
  • Console command system
  • Authentication
  • Data validation
  • Error handling
  • Logging
  • SQL query builder
  • Database migrations
  • Environment configuration via .env file

• Template Engine

  • Basic HTML template engine
  • Render Markdown files for quickly generating documentation sites from .md files
  • Render Swagger YAML files to display OpenAPI specifications without external UIs (e.g., without Swagger UI)

• Build a Forum Application

• Create Project Skeletons

  • For REST API applications
  • For documentation sites based on Markdown files