01_usage.md

Использование

Для запуска сайта требуется выполнить команду docker-compose up --build в корне сайта, для его остановки - достаточно нажать Ctrl+C или закрыть окно терминала.

После запуска сайт доступен по адресу http://localhost:7001.

Доступ Внутрь Контейнера

Для входа внутрь Docker контейнера c PHP следует воспользоваться командой docker exec -it laravelsu-php /bin/bash.

Внутри вам будут доступны:

• php - Интерпретатор PHP.
• composer - Актуальная версия Composer.

Работа С Данными

Для выгрузки самой последней документации из репозитория GitHub стоит воспользоваться командами:

• Выгрузка оригинальной документации

$ php artisan su:docs:fetch

• Выгрузка страниц переводов

$ php artisan su:docs:update

• Подсчёт отличий между оригиналом и переводами

$ php artisan su:docs:diff

Обратите внимание, что GitHub имеет ограничение на количество запросов и скорее всего у вас возникнет ошибка, которая содержит следующий текст:

\Github\Exception\RuntimeException You have reached GitHub hourly limit! Actual limit is: 60

В этот момент некоторая документация уже будет в наличии (скорее всего для Laravel 4.1) и ресурсом можно пользоваться.

Для выгрузки полной документации стоит прописать ключ GitHub в .env файл. Получить его можно на странице https://github.com/settings/tokens

1. Нажимаем на кнопку генерации нового токена (1).
2. Выставляем права на чтение репозиториев.
3. Получившийся ключ (2) вставляем в файл .env в качестве значения для переменной GITHUB_AUTH_ACCESS_TOKEN.

После этого выгрузку всей документации можно произвести полностью, от начала и до конца.