Тестовое задание на стажировку по вакансии «Back-End Developer« в команду VK ID.
Минимальные требования для запуска проекта:
- PHP 8.1 CLI
- Composer
Перед запуском нужно установить проект через Composer:
$ composer install
Для сервиса может использоваться любая база данных, поддерживаемая расширением PDO для PHP.
Сервис тестировался на СУБД MySQL. Также проверена работа с SQLite, так как он используется в юнит-тестах.
В папке sql
можно найти схемы базы данных:
Также перед запуском необходимо создать файл config.json
и заполнить его согласно примеру конфигурации: config.example.json
.
В конфигурации нужно указать данные для подключения к БД:
{
"db": {
"dsn": "mysql:host=127.0.0.1;dbname=register_auth",
"username": "someuser",
"password": "123456"
}
}
Перед загрузкой можно поместить в файл jwt_key.dat
ключ для создания и верификации
токенов JWT, закодированный при помощи Base64. Так как приложение использует алгоритм HS256
, то ключом может быть
абсолютно любая последовательность байтов.
Если файл jwt_key.dat
отсутствует, то приложение автоматически сгенерирует 32-байтовый ключ и запишет его в файл.
Чтобы запустить проект, следует воспользоваться PHP Built-in Web Server
в папке проекта:
$ php -S localhost:8080 router.php
Указанная выше команда запустит проект при помощи роутер-файла router.php
.
Можно проверить корректность логики кода, используя тесты PHPUnit.
Для этого можно воспользоваться командой:
$ composer test
Чтобы собрать образ Docker для сервиса, можно воспользоваться командой:
$ docker build -t register_auth .
Стоит заметить, что Dockerfile изначально собирается только с поддержкой SQLite и MySQL.
Если необходима поддержка иных СУБД, то следует дописать нужные расширения в строчку с командой docker-php-ext-install
.
Затем можно запустить образ Docker, указав в качестве тома конфигурационный файл и пробросив порт:
$ docker run -v ./config.json:/app/config.json -p 8080:8080/tcp register_auth
Документацию по API можно прочитать в отдельном файле.