Как начать работу с GoCore

В данном разделе описаны шаги по развертыванию и первичному запуску проекта на базе ядра GoCore.

1. Подготовка окружения

СУБД (MariaDB)

Для работы ядра требуется установленная MariaDB версии 10 и выше.

Вы можете установить её непосредственно в основную ОС или развернуть в контейнере.
Ядро не занимается автоматическим развертыванием СУБД (для серверов существуют отдельные скрипты, см. раздел DevOps).
Для подключения вам понадобятся:
- Хост: 127.0.0.1 (или localhost)
- Порт: 3306
- Логин и пароль пользователя с правами на создание БД (можно использовать root или создать отдельного пользователя).

2. Получение кодовой базы

Новый проект: Получите копию “чистого” ядра. Инициализируйте Git-репозиторий и разместите в нём код.
Существующий проект: Запросите доступ к репозиторию проекта и клонируйте его на свой компьютер.

3. Первичная сборка

Необходимо выполнить первичную сборку фронтенд-части и установку зависимостей.

Выполните запуск скрипта firstBuild из package.json:
```
npm run firstBuild
```
Этот скрипт последовательно выполняет: npm i && cd public && npm i && cd .. && babel public_src --out-dir public --copy-files.
В дальнейшем при разработке фронтенда используйте команду:
```
npm run watch
```

4. Настройка конфигурации

Файл config/config.json

Файл конфигурации исключен из Git и создается автоматически при первом запуске. После создания его необходимо отредактировать.

Запустите проект (команда npm run run или node bin/www.js).
Дождитесь появления ошибки о настройках БД и отредактируйте созданный файл config/config.json.

Основные параметры:

Хост и порт запуска: См. Параметры config.json -> Хост и порт запуска. По умолчанию 0.0.0.0, рекомендуется сменить на 127.0.0.1.
Подключение к СУБД: Настройте раздел mysqlConnection (см. Параметры config.json -> Раздел mysqlConnection).

Остальные параметры для первого запуска можно оставить без изменений.

5. Запуск и отладка

Компиляция TypeScript

Ядро поставляется с уже скомпилированным кодом (JS), но для разработки на TS вам потребуется компиляция:

В WebStorm: Включите опцию “Recompile on changes” в настройках TypeScript (иконка TS в нижней строке состояния).
В терминале: Запустите tsc или используйте npm run tsc.

Основной процесс

Запустите сервер:

npm run run
# или
node bin/www.js

Использование альтернативного конфига

Вы можете запустить проект с другим конфигурационным файлом (например, для отладки на копии продакшн-базы):

node bin/www.js prod.json

Файл должен находиться в директории config/.

Авторизация

После запуска перейдите по ссылке, отображенной в консоли.

Стандартные данные для входа (на чистой базе):
- Логин: admin
- Пароль: 123

Важные нюансы при первом запуске

Первый запуск: Создается config.json, процесс завершается с ошибкой подключения к БД.
Второй запуск: После настройки подключения ядро начинает заливать дамп БД из файла DB/ccs.init.sql. Это занимает некоторое время.
Дождитесь сообщения: INFO: cMysql.getConnection. Database has been filled. Enjoy your work!.
Перезапустите процесс еще раз.

Примечание: Сообщения в console.error при запуске — это нормально (они используются для выделения важных системных событий в логах). Читайте их внимательно, но паникуйте только если ошибки возникают во время работы уже запущенного сервера.

6. Резюме для разработчика

Бэкенд: Любые изменения в коде (кроме правок в tables.json) требуют перезапуска процесса.
Фронтенд: Исходники находятся в public_src, результат сборки — в public. Используйте npm run watch.
Документация: Перед началом полноценной разработки рекомендуется ознакомиться с разделом Описание общей концепции.