vtb-questionnaire v0.1.4

ВТБ Анкетный сервис/Дебетоые карты

💻 Требования к окружению

• Node.js 12+
• Git

🏗️ Сборка

# Development
yarn dev

# Production
yarn build

Динамический конфигурационный файл

• Сборка поддерживает динамический конфигурационный файл, который можно менять после сборки.
• Располагается в /src/GLOBAL_CONFIG.js
• Подключать рекомендуется через @lib/global-config, так как объект конфига глобальный и требуются манипуляции перед использованием конфига
• После сборки файл копируется в директорию сборки out/debit-card/GLOBAL_CONFIG.js и подключается в _document.ts

Особенности сборки

• Директория сборки /out
• Настройка Webpack & Next.js - next.config.js

⚙️ Стек технологий

• TypeScript
• React
• Redux Toolkit
• Next.js
• Webpack
• Babel
• ESLint
• Prettier
• Jest

🧪 Автотесты

yarn test

Особенности автотестов

• Настроены хуки на git push & git pull через husky.
• В директории /jest настраивается глобальное окружение

📋 Псевдонимы

• @components/* - /src/components/*
• @store/* - /src/store/*
• @vtb-adapter/ui-kit/* - /src/vtb-adapter/*
• @lib/* - /src/lib/*
• @public/* - /public/*

🖼️ Изображения

Изображения находятся в директории /public. Доступ к исзображениям можно получить через псевдоним @public/*

🗄️ Правила ведения стора

• Логика внутри reducer'ов не выше уровня CRUD, логика должна быть заключена в action creator'ах, при этом, по возможности, максимально вытеснена в selector'ы
• Ветки стора разбиваются в директории @store/features/* и объединяются в @store/index
• Структура веток:
  • /actions.ts - синхронные и ассинхронные action'ы
  • /selectors.ts - селекторы
  • /hooks.ts - фасадные хуки для работы с данными ветки
  • /index.ts - реализация reducer'a и реэкспорт остальных сущностей
  • /tests - автотесты

📚 Внутренние библиотеки @lib

TO DO

Правила ведения

• Если какая-то логика переиспользуется внутри проекта и не является компонентом, должна быть вынесена в папку @lib
• Структура библиотек:
  • /index.ts - реализация библиотеки
  • /reabme.md - документация
  • /tests - автотесты