Установка

Фреймворк поставляется как компактное PHP-ядро для небольших и средних проектов. В этом разделе показан минимальный путь от пустого проекта до первого рабочего маршрута.

Создание файла .env

Создайте файл .env в корне проекта и укажите в нём базовые параметры приложения:

APP_URL = http://localhost:8001

PDO_TYPE = mysql
PDO_HOST = db
PDO_PORT = 3306
PDO_NAME = app
PDO_CHARSET = utf8mb4
PDO_USER = root
PDO_PASSWORD = root
DB_WAIT_TIMEOUT = 300

FROM_MAIL = app@mail.ru
REPLY_TO_MAIL = noreply@mail.ru

STORAGE_ROOT_PATH = /storage/

Настройка msmtp

Если приложению нужна отправка почты, заполните файл .docker/etc/msmtprc данными вашего SMTP-сервера:

account default

auth on

tls on
tls_starttls off
tls_certcheck off

host mail.app.ru
port 465
user admin@mail.ru
password qwerty123456

logfile /var/log/msmtp.log

Подготовка дампа базы данных

Если проекту нужен стартовый набор таблиц или тестовых данных, добавьте SQL-запросы в файл .data/dump.sql. Они будут автоматически выполнены при первом запуске контейнера базы данных.

Добавление тестового маршрута

Откройте файл www/routes.php и добавьте в него минимальный маршрут:

use App\Http\Route;
use App\Http\Request;

Route::get('/', function (Request $request) {
    echo 'Hello, the framework!';
});

Сборка и запуск контейнеров

Выполните команду в терминале:

docker compose up -d --build

Установка Composer-зависимостей

При необходимости войдите в контейнер и выполните установку зависимостей вручную:

docker exec -it <имя_контейнера> /bin/bash
cd app/
composer install --no-dev --optimize-autoloader

Проверка результата

Откройте в браузере адрес http://localhost:8001.

Если всё настроено корректно, вы увидите:

Hello, the framework!