diff --git a/README.md b/README.md index 59a9a982..2a97e2bb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # UMS — Enterprise User Management System -> **[ 📚 OPEN MASTER INDEX ](./docs/MASTER_INDEX.md) • [ 🇪🇸 LEER EN ESPAÑOL ](./docs/README.es.md) • [ ⚙️ ARCHITECTURE PORTAL ](./docs/architecture/index.md)** +> **[OPEN STANDARDS](./docs/STANDARDS.md) • [OPEN MASTER INDEX](./docs/MASTER_INDEX.md) • [LEER EN ESPAÑOL](./docs/README.es.md) • [ARCHITECTURE PORTAL](./docs/architecture/index.md)** > *Note: GitHub displays source files first. To skip the code and read the documentation, click the links above.* --- @@ -11,6 +11,18 @@ --- +## Standards Quick Access + +| Need | Direct path | +| :--- | :--- | +| UMS applied React Web reference | [UMS React Web Applied Reference](./docs/architecture/web-frontend/ums-react-applied-reference.md) | +| UMS applied .NET API reference | [UMS API .NET Applied Reference](./docs/architecture/api-dotnet/ums-api-dotnet-applied-reference.md) | +| Upstream Evolith React standard | [Evolith React Web Frontend Standard](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/react-web-frontend-standard.md) | +| Upstream Evolith .NET API standard | [Evolith .NET API Standard](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/api-dotnet-standard.md) | +| All standards in one page | [Standards Quick Access](./docs/STANDARDS.md) | + +--- + ## Master Navigation Index Start here if you are new to UMS. This index gives each reader a fast route into the repository without needing to know the folder structure. @@ -18,8 +30,9 @@ Start here if you are new to UMS. This index gives each reader a fast route into | I am a… | Start here | Then read | | :--- | :--- | :--- | -| **Backend Engineer** | [Construction Portal](./docs/governance/construction/index.md) · [Domain Aggregate Index](./docs/domain/index.md) | [DDD Design Portal](./docs/governance/construction/ddd-design/index.md) → [Bounded Context Map](./docs/governance/construction/ddd-design/01-bounded-context-map.md) | -| **Architect** | [Architecture Portal](./docs/architecture/index.md) · [ADR Registry](./docs/architecture/adrs/index.md) | [Bounded Context Map](./docs/governance/construction/ddd-design/01-bounded-context-map.md) → [Traceability Matrix](./docs/architecture/traceability-matrix.md) | +| **Backend Engineer** | [Standards Quick Access](./docs/STANDARDS.md) · [Construction Portal](./docs/governance/construction/index.md) · [Domain Aggregate Index](./docs/domain/index.md) | [UMS API .NET Applied Reference](./docs/architecture/api-dotnet/ums-api-dotnet-applied-reference.md) → [DDD Design Portal](./docs/governance/construction/ddd-design/index.md) | +| **Frontend Engineer** | [Standards Quick Access](./docs/STANDARDS.md) · [UMS React Web Applied Reference](./docs/architecture/web-frontend/ums-react-applied-reference.md) | [Evolith React Web Frontend Standard](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/react-web-frontend-standard.md) | +| **Architect** | [Architecture Portal](./docs/architecture/index.md) · [ADR Registry](./docs/architecture/adrs/index.md) | [Standards Quick Access](./docs/STANDARDS.md) → [Traceability Matrix](./docs/architecture/traceability-matrix.md) | | **Product Owner / QA** | [Master Index](./docs/MASTER_INDEX.md) · [Functional Stories](./docs/governance/requirements/functional-stories/index.md) | [MVP Backlog](./docs/governance/project/mvp-product-backlog.md) → [Glossary](./docs/governance/requirements/glossary.md) | | **DevOps / Ops** | [Operations Portal](./docs/operations/index.md) · [Runbooks](./docs/operations/runbooks/) | [ADR-0053 OpenTelemetry](./docs/architecture/adrs/0053-opentelemetry-observability.md) → [ADR-0054 Shell Library Isolation](./docs/architecture/adrs/0054-shell-library-isolation.md) | @@ -27,6 +40,7 @@ Start here if you are new to UMS. This index gives each reader a fast route into | Goal | Start Here | Then Read | | :--- | :--- | :--- | +| Find standards for React, Web, C# or .NET | [Standards Quick Access](./docs/STANDARDS.md) | [Architecture Portal](./docs/architecture/index.md) | | Understand the product | [Product Vision](./docs/governance/product/product-vision.md) | [Business Context](./docs/governance/product/business-context.md) → [Scope](./docs/governance/product/scope.md) | | See Epics & Priorities | [MVP Product Backlog](./docs/governance/project/mvp-product-backlog.md) | [Requirements Index](./docs/governance/requirements/index.md) → [Functional Stories](./docs/governance/requirements/functional-stories/index.md) | | Review functional requirements | [Requirements Index](./docs/governance/requirements/index.md) | [Functional Stories](./docs/governance/requirements/functional-stories/index.md) → [Glossary](./docs/governance/requirements/glossary.md) | @@ -41,9 +55,9 @@ Start here if you are new to UMS. This index gives each reader a fast route into ### Technology Stack | Layer | Technology | | :--- | :--- | -| **Backend** | .NET 8 LTS, HotChocolate (GraphQL), Minimal APIs (REST) | +| **Backend** | .NET 10, HotChocolate (GraphQL), Minimal APIs (REST) | | **Frontend** | React 18, Vite 5, TypeScript, TailwindCSS, Zustand, TanStack Query | -| **Database** | SQL Server 2022, Entity Framework Core 8 | +| **Database** | SQL Server 2022, Entity Framework Core | | **Monorepo** | Nx, npm Workspaces | | **Methodology** | BMAD-METHOD, Clean Architecture (Hexagonal), DDD | @@ -78,7 +92,7 @@ src/ ### Prerequisites - Node.js 20+ -- .NET 8 SDK +- .NET 10 SDK - SQL Server 2022 (or Docker: `docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=YourPassword123!" -p 1433:1433 mcr.microsoft.com/mssql/server:2022-latest`) ### Frontend @@ -124,6 +138,7 @@ cd src/apps/ums.web-app && npm run dev ## Knowledge Hub | Domain | Portal Index | Contents | | :--- | :--- | :--- | +| **Standards** | [Standards Quick Access](./docs/STANDARDS.md) | Direct links to Evolith standards and UMS applied references for React Web and .NET API. | | **Governance** | [Governance Portal](./docs/governance/index.md) | Product direction, business scope, and functional requirements. | | **Project Delivery** | [Project Backlog](./docs/governance/project/index.md) | MVP epics, user stories, and functional design of core modules. | | **Requirements** | [Requirements Index](./docs/governance/requirements/index.md) | Functional stories, business glossary, and conceptual data model. | @@ -139,11 +154,3 @@ cd src/apps/ums.web-app && npm run dev - **CSRF Protection**: Double-submit cookie pattern with token refresh. - **Security Headers**: HSTS, X-Frame-Options, X-Content-Type-Options, Referrer-Policy via Nginx. - **Input Validation**: Zod schemas as single source of truth for runtime validation. - ---- - -## Contribution & Governance -- **Workflow**: This repo uses [BMAD-METHOD](./AGENTS.md) for spec-driven documentation. -- **Navigation**: Visit the [**Master Index**](./docs/MASTER_INDEX.md) for the full document tree. -- **Code Standards**: ESLint + TypeScript strict mode. Zero errors required before commit. -- **Testing**: Vitest with React Testing Library. Coverage thresholds: 60% lines/statements. diff --git a/docs/README.es.md b/docs/README.es.md index c8d5ec01..e0e0adf7 100644 --- a/docs/README.es.md +++ b/docs/README.es.md @@ -1,6 +1,6 @@ # UMS — Sistema de Gestión de Usuarios Empresarial -> **[ABRIR ÍNDICE MAESTRO](./MASTER_INDEX.es.md) • [READ IN ENGLISH](../README.md) • [PORTAL DE ARQUITECTURA](./architecture/index.es.md)** +> **[ABRIR ESTÁNDARES](./STANDARDS.es.md) • [ABRIR ÍNDICE MAESTRO](./MASTER_INDEX.es.md) • [READ IN ENGLISH](../README.md) • [PORTAL DE ARQUITECTURA](./architecture/index.es.md)** > *Nota: GitHub muestra los archivos de código primero. Para saltar el código y leer la documentación, haz clic en los enlaces de arriba.* --- @@ -11,12 +11,25 @@ --- +## Acceso rápido a estándares + +| Necesidad | Ruta directa | +| :--- | :--- | +| Referencia aplicada React Web UMS | [Referencia Aplicada React Web UMS](./architecture/web-frontend/ums-react-applied-reference.es.md) | +| Referencia aplicada API .NET UMS | [Referencia Aplicada API .NET UMS](./architecture/api-dotnet/ums-api-dotnet-applied-reference.es.md) | +| Estándar React upstream Evolith | [Estandar Web Frontend React Evolith](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/react-web-frontend-standard.es.md) | +| Estándar API .NET upstream Evolith | [Estandar API .NET Evolith](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/api-dotnet-standard.es.md) | +| Todos los estándares en una página | [Acceso Rápido a Estándares](./STANDARDS.es.md) | + +--- + ## Índice maestro de navegación Comience aquí si es nuevo en UMS. Este índice ofrece a cada lector una ruta rápida al repositorio sin necesidad de conocer la estructura de carpetas. | Quiero... | Empezar aquí | Luego leer | | :--- | :--- | :--- | +| Encontrar estándares React, Web, C# o .NET | [Acceso Rápido a Estándares](./STANDARDS.es.md) | [Portal de Arquitectura](./architecture/index.es.md) | | Entender el producto | [Visión del Producto](./governance/product-es/product-vision.md) | [Contexto de Negocio](./governance/product-es/business-context.md) → [Alcance](./governance/product-es/scope.md) | | Ver épicas y prioridades | [MVP Product Backlog](./governance/project-es/mvp-product-backlog.md) | [Índice de Requerimientos](./governance/requirements-es/index.md) → [Historias Funcionales](./governance/requirements-es/functional-stories/index.md) | | Revisar requerimientos funcionales | [Índice de Requerimientos](./governance/requirements-es/index.md) | [Historias Funcionales](./governance/requirements-es/functional-stories/index.md) → [Glosario](./governance/requirements-es/glossary.md) | @@ -126,10 +139,11 @@ cd src/apps/ums.web-app && npm install && npm run dev | Dominio | Índice del portal | Contenido | | :--- | :--- | :--- | +| **Estándares** | [Acceso Rápido a Estándares](./STANDARDS.es.md) | Enlaces directos a estándares Evolith y referencias aplicadas UMS para React Web y API .NET. | | **Gobernanza** | [Portal de Gobernanza](./governance/index.es.md) | Dirección del producto, alcance de negocio y requerimientos funcionales. | | **Entrega del proyecto** | [Backlog del Proyecto](./governance/project-es/index.md) | Épicas MVP, historias de usuario y diseño funcional de módulos core. | | **Requerimientos** | [Índice de Requerimientos](./governance/requirements-es/index.md) | Historias funcionales, glosario de negocio y modelo de datos conceptual. | -| **Arquitectura** | [Portal de Arquitectura](./architecture/index.es.md) | Diseño ER de base de datos, mapas de entidades y visores interactivos. | +| **Arquitectura** | [Portal de Arquitectura](./architecture/index.es.md) | Diseño ER de base de datos, entity maps y visores interactivos. | | **Construcción** | [Portal de Construcción](./governance/construction/index.es.md) | Diseño DDD de la capa de dominio: bounded contexts, agregados, eventos y comandos. | --- @@ -147,5 +161,6 @@ cd src/apps/ums.web-app && npm install && npm run dev - **Flujo de trabajo**: Este repositorio utiliza [BMAD-METHOD](../AGENTS.md) para documentación orientada a especificaciones. - **Navegación**: Visite el [Índice Maestro](./MASTER_INDEX.es.md) para el árbol completo de documentos. +- **Estándares aplicados**: Visite [Acceso Rápido a Estándares](./STANDARDS.es.md) para React Web, API .NET y referencias Evolith. - **Estándares de código**: ESLint + TypeScript strict mode. Cero errores requeridos antes de commit. - **Testing**: Vitest con React Testing Library. Umbrales de cobertura: 60% líneas/sentencias. diff --git a/docs/STANDARDS.es.md b/docs/STANDARDS.es.md new file mode 100644 index 00000000..00cc298a --- /dev/null +++ b/docs/STANDARDS.es.md @@ -0,0 +1,31 @@ +# Acceso Rapido a Estandares + +Usa esta pagina cuando necesites llegar rapido a las referencias aplicadas de UMS y a los estandares upstream de Evolith. + +## Referencias aplicadas UMS + +| Area | Referencia aplicada UMS | Estandar upstream Evolith | +|---|---|---| +| Frontend React Web | [Referencia Aplicada React Web UMS](./architecture/web-frontend/ums-react-applied-reference.es.md) | [Estandar Web Frontend React Evolith](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/react-web-frontend-standard.es.md) | +| Backend API .NET | [Referencia Aplicada API .NET UMS](./architecture/api-dotnet/ums-api-dotnet-applied-reference.es.md) | [Estandar API .NET Evolith](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/api-dotnet-standard.es.md) | + +## Accesos Evolith + +| Necesidad | Enlace | +|---|---| +| Todos los estandares por stack | [Evolith Quick Access by Stack](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/quick-access/README.es.md) | +| Portal estandar React | [Portal Web Frontend React](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/README.es.md) | +| Portal estandar API .NET | [Portal API .NET](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/README.es.md) | + +## Regla de autoridad + +| Tipo | Fuente de verdad | +|---|---| +| Estandar empresarial reutilizable | Evolith | +| Evidencia de implementacion especifica de producto | UMS | +| Ruta, modulo, header, schema, seed o valor runtime local | UMS | +| Practica destinada a todos los productos | Promover a Evolith mediante ADR, estandar o patron canonico | + +--- + +[Volver al README UMS](./README.es.md) diff --git a/docs/STANDARDS.md b/docs/STANDARDS.md new file mode 100644 index 00000000..fcc6e201 --- /dev/null +++ b/docs/STANDARDS.md @@ -0,0 +1,31 @@ +# Standards Quick Access + +Use this page when you need the shortest route to the UMS applied references and the upstream Evolith standards. + +## UMS applied references + +| Area | UMS applied reference | Upstream Evolith standard | +|---|---|---| +| React Web frontend | [UMS React Web Applied Reference](./architecture/web-frontend/ums-react-applied-reference.md) | [Evolith React Web Frontend Standard](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/react-web-frontend-standard.md) | +| .NET API backend | [UMS API .NET Applied Reference](./architecture/api-dotnet/ums-api-dotnet-applied-reference.md) | [Evolith .NET API Standard](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/api-dotnet-standard.md) | + +## Evolith shortcuts + +| Need | Link | +|---|---| +| All standards by stack | [Evolith Quick Access by Stack](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/quick-access/README.md) | +| React standard portal | [React Web Frontend Standard Portal](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/web-frontend/react/README.md) | +| .NET API standard portal | [.NET API Standard Portal](https://github.com/beyondnetcode/evolith_arch32/blob/main/reference/governance/standards/engineering/api-dotnet/README.md) | + +## Authority rule + +| Type | Source of truth | +|---|---| +| Reusable enterprise standard | Evolith | +| Product-specific implementation evidence | UMS | +| Local route, module, header, schema, seed or runtime value | UMS | +| Practice intended for all products | Promote to Evolith through ADR, standard or canonical pattern | + +--- + +[Back to UMS README](../README.md)