From 747d6489de8fa159e58dadd8dbbe33226f8114fe Mon Sep 17 00:00:00 2001 From: Vladimir Ulyanov Date: Sun, 8 Oct 2023 18:35:24 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20SNEGDEV-20=20=D1=81=D0=B4=D0=B5=D0=BB?= =?UTF-8?q?=D0=B0=D0=BB=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82?= =?UTF-8?q?=D0=B0=D1=86=D0=B8=D1=8E=20=D0=BF=D0=BE=20=D0=BC=D0=BE=D0=BD?= =?UTF-8?q?=D0=BE=D1=80=D0=B5=D0=BF=D0=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 13 ------------- docs/MONOREPO.md | 18 ++++++++++++++++++ 2 files changed, 18 insertions(+), 13 deletions(-) create mode 100644 docs/MONOREPO.md diff --git a/README.md b/README.md index bc389a0..ddc18cf 100644 --- a/README.md +++ b/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) diff --git a/docs/MONOREPO.md b/docs/MONOREPO.md new file mode 100644 index 0000000..e87113a --- /dev/null +++ b/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)