profinansy-ui-lib 3.3.18 → 3.3.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "profinansy-ui-lib",
-  "version": "3.3.18",
+  "version": "3.3.20",
   "main": "./dist/index.js",
   "license": "MIT",
   "devDependencies": {

package/readme.md

@@ -1,15 +1,71 @@
-# Флоу работы
-1. Создать ветку от master
-2. Сделать изменения, обновить версию в package.json, выполнить команду yarn build, запушить в гитлаб и открыть МР в мастер(прикрепляете ссылку на задачу в МР и кидаете его в группу ревью)
-3. Ревьювер посмотрит на МР, если это апрув, примет МР в main, и выполнит у себя локально команду npm publish
+# Общая библиотека компонентов
 
+## Описание проекта
+- Документация актуальных компонентов - https://master--651c1b79b512c24adef7cc46.chromatic.com/
 
-# Как смотреть изменения
+Проект предназначен для создания общих компонентов, которые используются в нескольких проектах сразу:
+1) UIKIT
+2) Header
+3) Footer
+4) SideMenu
+5) Layout
+6) Вспомогательные функции
+
+## Для начала работы
+1) Склонировать репозиторий ```git@profinansy.gitlab.yandexcloud.net:ru.profinansy/frontend/profinansy-react-components.git```
+2) Установить зависимости. Для этого в корневой папке проекта выполнить команду ```yarn install```
+3) Запустить сторибук ```yarn storybook```
+
+## Используемые команды
+#### Установка зависимостей
+```bash
+yarn install
+```
+#### Сборка проекта
+```bash
+yarn build
+```
+#### Апгрейд и публикация пакета
+```bash
+yarn pub
+```
+#### Проверка проекта линтером
+```bash
+yarn lint
+```
+#### Автоматическое исправление замечаний линтером
+```bash
+yarn lint:fix
+```
+#### Проверка проекта на типы
+```bash
+yarn types
+```
+#### Сборка сторибука в дев режиме (для разработки)
+```bash
+yarn storybook
+```
+#### Сборка сторибука для деплоя
+```bash
+yarn build-storybook
+```
+#### Сборка иконок в документацию
+```bash
+yarn icons:story
+```
+#### Деплой сторибука
+```bash
+yarn chromatic
+```
+
+## Нюансы по работу с проектом
+
+### Как смотреть изменения
 1. Надо расшарить локально репу общих компонентов, для этого в терминале в корневой директории проекта **profinansy-react-components** запустить команду **yarn link**
 2. В своем проекте, в котором используется эта репа(profinansy, к примеру),надо выполнить команду **yarn remove profinansy-ui-lib**, затем **yarn link profinansy-ui-lib**. Для применения изменений выполняйте команду **yarn build** в репозитории **profinansy-react-components**. Возможно то, что typescript будет кидать ошибки JSX типа "**cannot be used as a JSX component**", пока вы не отвяжете локальную привязку
 3. После завершения работы над компонентами, надо отвязать привязку: **yarn unlink profinansy-ui-lib**, затем **yarn add --force profinansy-ui-lib**
 
-## Как работать с иконками
+### Как работать с иконками
 
 Все иконки кладем в папку icons в формате svg. Подключать в компонент иконки
 можно напрямую через import. Они сгенерируются в компоненты автоматически
@@ -19,7 +75,7 @@
 ``yarn icons:story``. Он автоматически сгенерирует новый `.stories` файл
 и добавит все ваши новые иконки. 
 
-## Как работать с изображениями
+### Как работать с изображениями
 
 Если вам нужно использовать какое-либо изображение отличное от формата `.svg`, то скачиваете это изображение
 из фигмы и отправляете девопсам с просьбой залить его в файлохранилище. У себя уже просто вставляете ссылку,
@@ -27,7 +83,7 @@
 Изображения хранятся вот тут: https://storage.yandexcloud.net/public-files.profinansy.ru/images 
 
 
-## Темизация
+### Темизация
 
 Палитра и общий провайдер, который передает выбранную тему лежит в папке `theme`.
 Когда вы подключаете эту библиотеку к своему проекту, то оберните все приложение в провайдер
@@ -38,7 +94,27 @@ ThemeProvider. Через хук `useTheme` вы можете получить
 Чтобы компоненты из папки `uikit` также имели типизацию они должны быть все обренуты
 в ThemeProvider из `styled-components`
 
-## Storybook
+### Storybook
 Для всех компонентов используется сторибук. Все изменения можно смотреть там.
 Сторибук деплоится на chromatic. Для того, что задеплоить ваши изменения, сделайте коммит в гит, 
-а потом выполните команду ``yarn chromatic``
+а потом выполните команду ``yarn chromatic``
+
+## Файловая структура
+1) В папке **api** находятся функции запросов к бэкенду
+2) В папке **components** находятся все компоненты на проекте
+    - **blocks** - крупные блоки (header, footer и тд)
+    - **layouts** - общий лэйаут
+    - **modals** - общие модалки
+    - **uikit** - uikit проектов
+3) В папке **constants** находятся все константы
+4) папке **hooks** находятся все общие хуки
+5) папке **icons** находятся все иконки
+6) папке **theme** находятся все, что касается темизации
+7) папке **urls** находятся объекты с роутингом
+8) папке **utils** находятся все вспомогательные функции
+
+## Процесс работы над задачей
+https://wiki.corp.profinansy.net/pages/viewpage.action?pageId=4948261
+
+## Регламенты разработки
+https://wiki.corp.profinansy.net/pages/viewpage.action?pageId=4948295