@bitzlato/baseapp

This is a react application of the trading platform

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

Для разработки необходимы:

1. nvm github.com/nvm-sh/nvm
2. direnv direnv.net

(опционально) Для развёртывания потребуется:

1. rbenv github.com/rbenv/rbenv и ruby-build github.com/rbenv/ruby-build
2. bundler bundler.io

Далее вам нужно выполнить:

nvm use
corepack enable
yarn rebuild
cp .envrc.development .envrc
direnv allow
ln -s env.localdev.js web/public/config/env.js

Теперь у вас всё готово для работы!

Запуск в режиме разработки

Быстрый запуск с проксированием на стейдж

yarn start

Запуск вместе с shared компонентами

yarn start:all

Для ручной настройки доступны следующие переменные окружения:

Variable	Description
PROXY_HOST	Хост сервера, на который будут проксироваться остальные API запросы
HOST	Указаный хост будет использовать dev server
PORT	Указаный порт будет использовать dev server
MARKET_DOCS_URL	Указывает на то, где находится docs.js
AUTH0_DOMAIN	Домен сервера auth0
AUTH0_CLIENT_ID	Идентификатор клиента auth0

Дополнительные опции для режима разработки

VANILLA_EXTRACT_DEBUG=1 – Включит удобночитаемые индификаторы классов для vanilla-extract (Значительно увеличивает время запуска для процессоров M1)

VANILLA_EXTRACT_DEBUG=1 yarn start

Вебсокет соединение требуется для:

1. Обновления чатов и статусов сделок
2. Получение уведомлений

Деплой на прод

sh ./release
bundle exec cap production deploy

Создать версию для стейджа

sh ./version-staging

В github actions запустится задача на сборку и пуш контейнера

Сборка проекта

yarn build

Возможно получить детальный отчет по сборке

ANALYZE=enable yarn workspace web run build

Тестирование

Юнит тесты:

yarn test

Проверка кода:

yarn lint

Заглушка "Обслуживание"

Установить

cap production maintenance:enable REASON="maintenance" UNTIL="12:00pm GTM"

Снять

cap production maintenance:disable

Переводы

Доступна команда для импорта json-файлов из Tolgee. Необходимо предворительно настроить переменные окружения TOLGEE_URL, TOLGEE_MAIN_API_KEY и TOLGEE_SHARED_API_KEY

# .envrc
export TOLGEE_URL=<URL_TO_TOLGEE>
export TOLGEE_MAIN_API_KEY=<YOUR_PROJECT_API_KEY>
export TOLGEE_SHARED_API_KEY=<YOUR_PROJECT_API_KEY>

yarn workspace web run tolgee:import

Contributing

• Соблюдайте соглашения сообщения коммитов www.conventionalcommits.org. И прочтите наш путиводитель github.com/bitzlato/guides
• Тестируйте свой код. Мы ожидаем, что вы проверите свой код перед отправкой