Merge pull request #1 from sneg240/SNEGDEV-20

SNEGDEV-20 сделал документацию по монорепе

README.md

@@ -1,15 +1,3 @@
-# Turborepo starter
-
-This is an official starter Turborepo.
-
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest
-```
-
 ## What's inside?
 
 This Turborepo includes the following packages/apps:
@@ -78,4 +66,3 @@ Learn more about the power of Turborepo:
 - [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
 - [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
 - [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
-- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)

docs/MONOREPO.md

@@ -0,0 +1,18 @@
+# Описание устройства монорепозитория
+
+1. Монорепозиторий управляется связкой turborepo + pnpm
+2. pnpm обеспечивает управление зависимостями, их установку и контроль версий
+3. turborepo обеспечивает кеширование и оркестрирование выполнения скриптов, а так же кодогенерацию
+
+## Полезные команды
+
+1. Установить зависимости - `pnpm i`
+2. Запустить сторибук в одном из пакетов (например - "ui") - `turbo run dev --filter=@sneg240/ui` (см. [turbo.json](../turbo.json) и [@sneg240/ui/package.json](../packages/ui/package.json))
+3. Запустить автоматические проверки во всем проекте - `turbo run check` (см. [turbo.json](../turbo.json))
+4. Сгенерировать новый пакет - `pnpm run generate:package` (см. [package.json](../package.json))
+
+## Полезные ссылки
+
+- [Turborepo CLI](https://turbo.build/repo/docs/reference/command-line-reference)
+- [Turborepo CodeGen](https://turbo.build/repo/docs/core-concepts/monorepos/code-generation)
+- [Turborepo Filter](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)