how-to-run.md

Как запустить Доку локально

Для работы с платформой вам потребуется Node.js и npm. Мы используем стабильную LTS-версию Node.js и версию npm, которая идёт в комплекте. Если у вас установлена другая версия Node.js, вы можете использовать nvm для переключения на нужную.

Минимальный запуск

Чтобы запустить Доку локально, нужно:

1. Скачать репозиторий.
2. Установить зависимости командой npm i.
3. Сделать копию файла .env.example и назвать его .env. Задать в нём нужные переменные окружения.
4. Запустить локальный веб-сервер командой npm start.

Запуск с сервис воркером

Чтобы запустить Доку с сервис воркером, нужно:

1. Сделать всё описанное в предыдущем пункте.
2. Добавить переменную DOKA_MODE в localStorage.
3. Установить значение переменной DOKA_MODE в DEBUG.

Запуск с реальным контентом

1. Скачать репозитории с контентом и платформой в одну папку.
2. Установить зависимости командой npm i.
3. Сделать копию файла .env.example и назвать его .env. Задать в нём нужные переменные окружения:

• BASE_URL - базовый адрес для сайта;
• SECTIONS - список разделов сайта;
• PATH_TO_CONTENT - путь до репозитория с контентом;
• CONTENT_REP_FOLDERS - папки с содержимым разделов и служебной информацией для сборки;
• DOKA_ORG - путь до организации на GitHub;
• PLATFORM_REP_GITHUB_URL - путь до репозитория с платформой на GitHub;
• CONTENT_REP_GITHUB_URL - путь до репозитория с контентом на GitHub;
• CONTENT_REP_GITHUB - ссылка до репозитория с контентом на GitHub для работы с Git;
• SERVER_PATH - абсолютный путь до папки на сервере с текущей сборкой;
• GITHUB_TOKEN - токен для работы с GraphQL GitHub (персональный токен можно сгенерировать, как описано в инструкции).

2. Запустить локальный веб-сервер командой npm start.

Если оставить поле GITHUB_TOKEN пустым, на страницах участников не будет отображена информация об активности на GitHub в репозитории с контентом.