{"id":40713999,"url":"https://github.com/profcomff/ui-kit","last_synced_at":"2026-01-21T13:05:28.381Z","repository":{"id":320619294,"uuid":"1082463257","full_name":"profcomff/ui-kit","owner":"profcomff","description":"Viribus Unitis UI kit","archived":false,"fork":false,"pushed_at":"2025-12-18T18:52:48.000Z","size":283,"stargazers_count":0,"open_issues_count":9,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-21T04:48:13.616Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/profcomff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-24T09:24:16.000Z","updated_at":"2025-11-26T20:19:38.000Z","dependencies_parsed_at":"2025-10-24T21:20:27.778Z","dependency_job_id":"af465ca1-02d9-421b-87f1-752d661304e9","html_url":"https://github.com/profcomff/ui-kit","commit_stats":null,"previous_names":["profcomff/ui-kit"],"tags_count":0,"template":false,"template_full_name":"profcomff/vuets-template","purl":"pkg:github/profcomff/ui-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fui-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fui-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fui-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fui-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/profcomff","download_url":"https://codeload.github.com/profcomff/ui-kit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fui-kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28633747,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-21T13:05:27.559Z","updated_at":"2026-01-21T13:05:28.373Z","avatar_url":"https://github.com/profcomff.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Viribus Unitis UI kit\n\nЗдесь мы разрабатываем компоненты, общие для интерфейсов\n\u003ca href=\"https://app.profcomff.com\" target=\"_blank\"\u003eТвой ФФ\u003c/a\u003e и всех\n\u003ca href=\"https://app.profcomff.com/apps\" target=\"_blank\"\u003eминиприложений\u003c/a\u003e. База компонентов и стилей\nберется из \u003ca href=\"https://vuetifyjs.com/en/components/all/\" target=\"_blank\"\u003eVuetify\u003c/a\u003e, а дизайн-система\nописана в нашей\n[Фигме](https://www.figma.com/design/gfvuDN9x7I7sFCJQ7b1bIz/%D0%A2%D0%B2%D0%BE%D0%B9-%D0%A4%D0%A4--%7C-Viribus?node-id=5399-18531\u0026t=gqJoSlE0UHgEkayo-0).\n\n_Большая часть команд и инструкций написаны для операционных систем Linux и MacOS._\n\n## Использование\n\nTODO: Библиотека можно будет установить из npm под скоупом @profcomff. Она будет устанавливаться как плагин, и внедрять в глобальный скоуп приложения все компоненты -- по аналогии с vuetify. Все наши компоненты будут иметь приставку `Vu` (Viribus Unitis): `VuButton`, `VuTag` и т.д.\n\nTODO: Для референса нужно будет захостить собранный сторибук.\n\n## Зависимости\n\n- Node.js \u003e= v18 – среда исполнения на языке JavaScript/TypeScript\n- NPM – консольный менеджер пакетов для установки библиотек (идет в поставке с Node.js)\n- Vue.js – фреймворк для разработки фронтенда\n- Vite – консольный менеджер и инструмент сборки для удобства работы с Vue.js\n- Storybook – фреймворк для разраобтки и документации компонентов и экранов.\n\n## Разработка\n\nДля удобства разработки в VS Code создан [workspace](../frontend.code-workspace) с преднастроенными\nкомандами и рекомендованными расширениями для работы.\n\n### Начало работы\n\nПеред началом работы нужно установить зависимости командой\n\n```\npnpm install\n```\n\nЕсли используешь VS Code, то следует настроить автоформатирование:\n\n1. Открыть файл с расширением `.vue`.\n2. Открыть палитру команд (Help \u003e Show All Commands или `Ctrl+Shift+P`)\n3. Ввести и выбрать `Format document with`.\n4. Выбрать `Configure Default Formatter`.\n5. Выбрать `Prettier`.\n\nТеперь можно форматировать файлы с помощью `Shift+Alt+F`. Еще можно настроить автоформатирование при сохранении файла (File \u003e Preferences \u003e Settings, Format on save).\n\n### Работа со Storybook\n\nДля локального запуска Storybook необходимо выполнить команду\n\n```\npnpm sb\n```\n\nНа localhost порте 6006 откроется storybook. Он поддерживает перезагрузку при изменении кода (hot module replacement), но иногда может что-то кешировать -- тогда лучше перезапустить.\n\nВ левой вкладке будут перечислены все истории -- это могут быть компоненты, наборы компонентов или целые экраны. При нажатии на них можно посмотреть на то, как компонент выглядит, попробовать поменять какие-то его параметры и посмотреть, как он реагирует на события (например, нажатие).\n\nСоздание компонента:\n\n1. В папке `/src/components/` создай папку с названием компонента (например, `button`).\n2. Создай в этой папке файл `Vu{НазваниеКомпонента}.vue` и в нем описываем шаблон компонента.\n3. Стилизуй компонент с помощью классов vuetify.\n4. Опиши модели и пропы, которые может принимать компонент. С помощью /\\*\\* \\*/ опиши пропы и модели (так автоматически генерируется документация).\n5. Чтобы отразить псевдо-состяния (hover, active и т.д.), напиши в истории:\n    ```ts\n    parameters: {\n    \tpseudo: {\n    \t\thover: true,\n    \t}\n    }\n    ```\n    или посмотри [доку](https://storybook.js.org/addons/storybook-addon-pseudo-states) аддона.\n6. В этой же папке создай `Vu{НазваниеКомпонента}.stories.ts`.\n7. В этом файле опиши meta, а потом истории -- различные состояния и опции компонента. Подробнее смотри в туториале Storybook или в уже написанных компонентах.\n\n### Пулл-реквест\n\n- Перед отправкой проверь стили: `pnpm check`\n- _Опционально_: более строгая проверка `pnpm check:hard`.\n- Заполни шаблон пулл-реквеста: что, как и зачем сделал\n- Запроси ревью\n\n### Запуск приложения (опционально)\n\nДля локального запуска приложения (чтобы проверять компоненты вне сторибука) необходимо выполнить команду\n\n```\npnpm dev\n```\n\nДля локального запуска Storybook необходимо выполнить команду \n```\npnpm sb\n```\n\n\n## Инструкции\n\n### Получение кода на свой компьютер\n\n1. Открой приложение \"Командная строка\" или \"Терминал\", в зависимости от операционной системы.\n2. Прейди в папку, где хочешь создать папку проекта, командой `cd /путь/к/папке`.\n    - Если ты пользователь windows и хотите создать папку на рабочем столе, то команда будет\n      выглядеть так: `cd %userprofile%/Desktop`\n    - Если ты пользователь linux или MacOS и хочещб создать папку на рабочем столе, то команда\n      будет выглядеть сделующим образом: `cd ~/Desktop/`\n3. Склонируй код репозитория к себе на ПК командой\n   `git clone https://github.com/profcomff/ui-kit.git myapp` (вместо `myapp` подставь название папки, которая будет создана).\n4. Открой код в удобной среде разработки. Рекомендуем использовать VSCode, который можно открыть\n   из терминала командой `code .`\n\n### Сборка библиотеки\n\nTODO: Здесь будет описание сборки и публикации библиотеки на npm.\n\n### Автосборка\n\nTODO: Настроить на релиз.\n\nКоммит в main запускает автоматическую сборку проекта средствами GitHub Actions. Настройки автосборки находятся в\nфайле [.github/workflows/build_and_publish.yml](.github/workflows/build_and_publish.yml).\n\n### Тесты на Pull Request\n\nПри создании запроса на слияние, автоматически создаются проверки кода юниттестами и на стили.\nСледующие тесты будут запущены:\n\n- Проверки стилей `eslint`, `prettier`, `stylelint` на код в папке `frontend`\n\nНастройки автотестов находятся в файле[.github/workflows/checks.yml](.github/workflows/checks.yml).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofcomff%2Fui-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprofcomff%2Fui-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofcomff%2Fui-kit/lists"}