Установка Elang из терминала#

Приложения Elang устанавливаются с помощью Composer. Текущая предварительная версия распространяется через репозиторий Composer Elang, поэтому параметр репозитория является частью рабочей команды. Вручную скачивать или распаковывать исходный код не нужно.

Перед началом#

Установите PHP 8.3+ в пределах ветки PHP 8.x и Composer 2. Выполните php -v и composer --version для проверки. Если какая-либо команда недоступна, следуйте руководству по настройке окружения. Требуемые расширения и драйверы баз данных перечислены в требованиях.

Создайте первое приложение#

Выполните команды в родительском каталоге, где хотите разместить новый проект:

composer create-project --repository=https://elangphp.com/packages elang/elang my-app 0.1.0-dev
cd my-app
php elang serve

Composer создаёт my-app, устанавливает Elang и его зависимости, генерирует ключ приложения и запускает doctor. После запуска сервера откройте http://127.0.0.1:8000.

Ожидаемый результат: приветственная страница с надписью «Your next idea starts here» («Ваша следующая идея начинается здесь»). Созданное приложение также включает /api/hello/Ada, который возвращает {"message":"Hello, Ada!"}.

Используйте новый или пустой каталог. Если в my-app уже есть файлы, выберите другое имя, чтобы не перезаписать свою работу. Нажмите Ctrl+C, чтобы остановить локальный сервер.

Один раз установите Elang CLI#

Если предпочитаете команду elang new, зарегистрируйте репозиторий Composer и установите CLI глобально:

composer global config repositories.elang composer https://elangphp.com/packages
composer global require elang/installer:0.1.0-dev

Найдите каталог исполняемых файлов командой:

composer global config bin-dir --absolute

Добавьте выведенный каталог в пользовательскую переменную PATH и заново откройте терминал. В Windows используйте редактор переменных среды пользователя и добавьте этот каталог в Path. В macOS или Linux добавьте каталог в PATH в профиле своей оболочки. Затем проверьте elang --version.

Теперь создавайте проекты командами:

elang new my-app
cd my-app
php elang serve

Установщик вызывает Composer для создания приложения. После установки хранить копию исходного репозитория фреймворка на компьютере не требуется.

Начните с полноценного учебного проекта#

Создайте доску задач непосредственно через Composer:

composer create-project --repository=https://elangphp.com/packages elang/task-board task-board 0.1.0-dev
cd task-board
php elang serve

Или после установки глобального CLI:

elang new task-board --example=task-board

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

Разберитесь в двух консольных командах#

elang new — глобально установленная команда создания проектов. php elang ... запускает консоль приложения из текущего каталога. Используйте консоль приложения для doctor, маршрутов, миграций, генераторов и локального сервера.

php elang doctor
php elang routes
php elang make:controller HelloController

Распространение предварительной версии и Packagist#

Сейчас доступны девять пакетов: elang/framework, elang/elang, elang/task-board, elang/installer, elang/auth-starter, elang/blog, elang/dashboard, elang/api и elang/realtime. Это пакеты Composer, размещённые по адресу https://elangphp.com/packages.

Публичный выпуск в Packagist пока не опубликован, поэтому обычная установка Composer без параметра репозитория сейчас не поддерживается. До такой публикации не рассчитывайте, что сокращённая команда только для Packagist будет работать. Текущая версия остаётся изменяющейся предварительной версией для разработчиков.

Если установка остановилась#

Прочитайте первую ошибку Composer. Отсутствующие расширения, неподдерживаемая версия PHP, занятый каталог назначения и недоступность HTTPS-репозитория требуют разных решений. Не скрывайте требования платформы с помощью --ignore-platform-reqs.

Если зависимости установлены, но проверка после создания проекта не прошла, перейдите в новый каталог, устраните указанную проблему и снова выполните php elang doctor. Сохраните сгенерированный ключ .env. См. устранение неполадок.

Для участников разработки фреймворка#

Клонируйте исходный репозиторий, выполните composer install и используйте php elang new ../my-app --local, чтобы проверить очищенный локальный снимок фреймворка. Этот рабочий процесс для участников разработки отличается от установки приложения через Composer. Проверки репозитория описаны в CONTRIBUTING.md, а сборка пакетов для распространения — в bin/build-packages.

Выберите готовый стартовый проект#

elang new accounts --starter=auth
elang new journal --starter=blog
elang new workspace --starter=dashboard
elang new notes-api --starter=api

Каждый стартовый проект содержит собственные миграции и полный исходный код. Composer применяет схему стартового проекта во время настройки. Перед развёртыванием общедоступного приложения прочитайте руководства по аутентификации, моделям, Studio, блогу, панели управления и защищённому API.