Feat/readme

.gitignore

@@ -45,5 +45,7 @@ dist/
 *.iml
 *.idea
 
+.junie/
+
 # next.js output
 .next

README.md

@@ -1,89 +1,69 @@
 ![nestjs-github-cover](https://user-images.githubusercontent.com/102182195/235650080-e661338e-4466-43f7-84fc-f801558495eb.png)
 
-# NestJS Custom Workshop
-
-[//]: # 'VERSIONS'
-
-[<img src="https://img.shields.io/npm/v/@atls/schematics?style=for-the-badge&label=%40atls%2Fschematics&labelColor=ECEEF5&color=D7DCEB">](https://npmjs.com/package/@atls/schematics)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-batch-queue?style=for-the-badge&label=%40atls%2Fnestjs-batch-queue&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-batch-queue)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-connectrpc?style=for-the-badge&label=%40atls%2Fnestjs-connectrpc&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-connectrpc)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-connectrpc-errors?style=for-the-badge&label=%40atls%2Fnestjs-connectrpc-errors&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-connectrpc-errors)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-cqrs?style=for-the-badge&label=%40atls%2Fnestjs-cqrs&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-cqrs)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-cqrs-kafka-events?style=for-the-badge&label=%40atls%2Fnestjs-cqrs-kafka-events&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-cqrs-kafka-events)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-dataloader?style=for-the-badge&label=%40atls%2Fnestjs-dataloader&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-dataloader)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-external-renderer?style=for-the-badge&label=%40atls%2Fnestjs-external-renderer&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-external-renderer)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-gateway?style=for-the-badge&label=%40atls%2Fnestjs-gateway&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-gateway)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-gcs-client?style=for-the-badge&label=%40atls%2Fnestjs-gcs-client&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-gcs-client)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-graphql-redis-subscriptions?style=for-the-badge&label=%40atls%2Fnestjs-graphql-redis-subscriptions&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-graphql-redis-subscriptions)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-grpc-errors?style=for-the-badge&label=%40atls%2Fnestjs-grpc-errors&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-grpc-errors)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-grpc-http-proxy?style=for-the-badge&label=%40atls%2Fnestjs-grpc-http-proxy&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-grpc-http-proxy)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-grpc-identity?style=for-the-badge&label=%40atls%2Fnestjs-grpc-identity&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-grpc-identity)
-[<img src="https://img.shields.io/npm/v/@atls/grpc-keto?style=for-the-badge&label=%40atls%2Fgrpc-keto&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/grpc-keto)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-grpc-playground?style=for-the-badge&label=%40atls%2Fnestjs-grpc-playground&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-grpc-playground)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-grpc-reflection?style=for-the-badge&label=%40atls%2Fnestjs-grpc-reflection&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-grpc-reflection)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-hydra?style=for-the-badge&label=%40atls%2Fnestjs-hydra&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-hydra)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-kafka?style=for-the-badge&label=%40atls%2Fnestjs-kafka&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-kafka)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-keto?style=for-the-badge&label=%40atls%2Fnestjs-keto&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-keto)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-kratos?style=for-the-badge&label=%40atls%2Fnestjs-kratos&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-kratos)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-logger?style=for-the-badge&label=%40atls%2Fnestjs-logger&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-logger)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-microservices-registry?style=for-the-badge&label=%40atls%2Fnestjs-microservices-registry&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-microservices-registry)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-mikro-orm-config?style=for-the-badge&label=%40atls%2Fnestjs-mikro-orm-config&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-mikro-orm-config)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-mikro-orm-request-context?style=for-the-badge&label=%40atls%2Fnestjs-mikro-orm-request-context&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-mikro-orm-request-context)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-pipes?style=for-the-badge&label=%40atls%2Fnestjs-pipes&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-pipes)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-proto-types?style=for-the-badge&label=%40atls%2Fnestjs-proto-types&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-proto-types)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-redis?style=for-the-badge&label=%40atls%2Fnestjs-redis&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-redis)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-s3-client?style=for-the-badge&label=%40atls%2Fnestjs-s3-client&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-s3-client)
-[<img src="https://img.shields.io/npm/v/@atlantis-lab/nestjs-signed-url?style=for-the-badge&label=%40atlantis-lab%2Fnestjs-signed-url&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atlantis-lab/nestjs-signed-url)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-typeorm-seeding?style=for-the-badge&label=%40atls%2Fnestjs-typeorm-seeding&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-typeorm-seeding)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-typesense?style=for-the-badge&label=%40atls%2Fnestjs-typesense&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-typesense)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-typesense-typeorm?style=for-the-badge&label=%40atls%2Fnestjs-typesense-typeorm&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-typesense-typeorm)
-[<img src="https://img.shields.io/npm/v/@atls/nestjs-validation?style=for-the-badge&label=%40atls%2Fnestjs-validation&labelColor=CB5458&color=BE4045">](https://npmjs.com/package/@atls/nestjs-validation)
-
-[//]: # 'VERSIONS'
-
-**atls/nestjs** - это набор модулей для [NestJS](https://nestjs.com/), разработанный для упрощения разработки и улучшения продуктивности работы с фреймворком.
-
-В этом репозитории собраны полезные инструменты, интеграции и расширения, которые обеспечивают гибкость и мощь при создании современных приложений с использованием популярного фреймворка NestJS.
-
-## 🌟&nbsp;&nbsp;Особенности:
-
-- Работа с различными технологиями и сервисами, такими как GraphQL, gRPC, логгирование, тестирование и другие.
-- Поддержка автоматической интеграции с популярными сервисами, такими как Hydra, Keto и Kratos.
-- Встроенное управление ошибками и их обработка в gRPC.
-- Гибкость и модульность для настройки под различные задачи и проекты.
-
-## 💼&nbsp;&nbsp;Включает следующие пакеты:
-
-1. `batch-queue` - пакетная обработка задач и очередей.
-2. `connectrpc` - интеграция ConnectRPC с NestJS.
-3. `connectrpc-errors` - обработка ошибок для ConnectRPC.
-4. `cqrs` - реализация паттерна CQRS.
-5. `cqrs-kafka-events` - интеграция CQRS-событий с Kafka.
-6. `dataloader` - интеграция с DataLoader для оптимизации запросов.
-7. `external-renderer` - поддержка рендеринга на стороне сервера.
-8. `gateway` - модуль для работы с GraphQL Mesh.
-9. `gcs-client` - клиент для Google Cloud Storage.
-10. `graphql-redis-subscriptions` - GraphQL subscriptions через Redis.
-11. `grpc-errors` - стандартизация обработки ошибок для gRPC.
-12. `grpc-http-proxy` - HTTP-прокси для gRPC-сервисов.
-13. `grpc-identity` - аутентификация и авторизация для gRPC-сервисов.
-14. `grpc-keto` - gRPC-интеграция с Ory Keto.
-15. `grpc-playground` - интеграция с gRPC Playground для тестирования и отладки.
-16. `grpc-reflection` - поддержка gRPC Server Reflection.
-17. `hydra` - интеграция с Hydra для работы с OAuth2 и OpenID Connect.
-18. `kafka` - интеграция с Apache Kafka.
-19. `keto` - интеграция с Ory Keto для авторизации.
-20. `kratos` - интеграция с Ory Kratos для аутентификации и управления идентификацией.
-21. `logger` - инструмент для расширенного логгирования.
-22. `microservices-registry` - реестр микросервисов.
-23. `mikro-orm-config` - конфигурация MikroORM.
-24. `mikro-orm-request-context` - контекст запроса для MikroORM.
-25. `pipes` - набор утилитарных pipes.
-26. `proto-types` - типы и утилиты для proto-контрактов.
-27. `redis` - интеграция с Redis.
-28. `s3-client` - клиент для S3-совместимых хранилищ.
-29. `signed-url` - поддержка создания и проверки подписанных URL.
-30. `typeorm-seeding` - инструмент для наполнения баз данных с использованием TypeORM.
-31. `typesense` - модуль для работы с поисковым движком Typesense.
-32. `typesense-typeorm` - интеграция TypeORM с Typesense для работы с полнотекстовым поиском.
-33. `validation` - утилиты для валидации данных.
+# @atls/nestjs
+
+NestJS Infrastructure-first toolkit
+
+- CQRS, gRPC, Kafka, Auth, Storage
+
+## What’s inside
+
+### Transport
+
+- gRPC (errors, reflection, playground, http-proxy)
+- ConnectRPC (errors)
+- GraphQL Gateway (redis-subscriptions)
+
+### Messaging & Async
+
+- Kafka (cqrs)
+- CQRS
+- Batch Queue
+
+### Auth & Identity
+
+- Hydra
+- Kratos
+- Keto
+- gRPC Identity
+
+### Persistence & Infra
+
+- Redis
+- S3 / GCS
+- MikroORM / TypeORM
+- Typesense (typeorm)
+- Signed URL
+
+### DX & Utilities
+
+- Logger
+- Validation
+- Pipes
+- Proto Types
+- Dataloader
+- Microservices Registry
+- External Renderer
+
+## Development
+
+This repo uses [Yarn 4](https://yarnpkg.com/) and [ESM](https://nodejs.org/api/esm.html).
+
+### Build
+
+```bash
+yarn workspaces run build
+```
+
+## Why
+
+- opinionated infra
+- consistent error model
+- zero glue code between services
+- production-first defaults
+
+## 🚀 Examples
+
+- [`grpc-http-proxy`](examples/grpc-http-proxy) - пример HTTP-прокси для gRPC-сервисов.
+- [`grpc-playground`](examples/grpc-playground) - пример использования gRPC Playground.
+- [`grpc-reflection`](examples/grpc-reflection) - пример использования gRPC Server Reflection.