Skip to content

Commit cabe34c

Browse files
committed
docs: implement high-level minimalist Executive Portal READMEs
1 parent 4987203 commit cabe34c

5 files changed

Lines changed: 68 additions & 50 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,12 @@ Commands for Backend (run from within `./src/apps/app-api-dotnet/` or root solut
2424
- Pattern: Clean Architecture (Hexagonal), SOLID, Explicit Bounded Contexts.
2525

2626
## Conventions
27-
- Adhere to the **spec-driven AI strategy BMAD-METHOD** for numerical sequential documentation (Phases 00 to 05).
28-
- Strictly isolate Domain rules from external frameworks.
27+
- **Engineering Patterns**: Adhere to **Clean Architecture** (Hexagonal), **SOLID** principles, and strict **DDD** bounded contexts.
28+
- **AI-Driven Strategy**: Utilize the **BMAD-METHOD** for spec-driven development and numerical sequential documentation (Phases 00 to 05).
29+
- **Domain Purity**: Strictly isolate Domain rules from external frameworks.
2930
- JS/TS: Hexagonal boundaries and strict linting.
3031
- C#: `{BoundedContext}.Domain` project must be pure POCOs with zero NuGet references.
31-
- Utilize the **Result Pattern** instead of throwing application exceptions for domain flow control.
32+
- **Flow Control**: Utilize the **Result Pattern** instead of throwing application exceptions for domain flow control.
3233
- Enforce strict TypeScript and C# types with static analysis gates (SonarJS).
3334

3435
## Agent Rules

MASTER_INDEX.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> **Language:** [English](./MASTER_INDEX.md) | [Espanol](./MASTER_INDEX.es.md)
44
5-
Phase-based navigation for the User Management System (UMS) documentation.
5+
Product Lifecycle and Engineering Specifications for the User Management System (UMS).
66

77
---
88

README.es.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,40 @@
1-
# Workspace del Monorepo UMS
1+
# UMS — Sistema de Gestión de Usuarios Empresarial
22

3-
> **Idioma:** [English](./README.md) | [Espanol](./README.es.md)
3+
> **Monolito Modular de alta escala para Identidad y Autorización Unificada.**
4+
>
5+
> ![Estado](https://img.shields.io/badge/Estado-Activo-success) ![Arch](https://img.shields.io/badge/Arquitectura-Monolito_Modular-blue) ![Engine](https://img.shields.io/badge/Motor-.NET_8_/_React-informational)
46
5-
Workspace Nx para el Sistema de Gestion de Usuarios -- backend .NET 8 y frontend React.
7+
---
68

7-
## Stack Tecnologico
9+
### 🚀 Hub de Navegación
10+
Explora las capas del repositorio:
811

9-
- **Frontend:** React 18 / Vite / Zustand / TanStack Query
10-
- **Backend:** .NET 8 LTS / ASP.NET Core / MediatR / FluentValidation
11-
- **Datos:** PostgreSQL 16 / EF Core (Npgsql)
12-
- **Herramientas:** Nx / npm Workspaces / CSharpier / ESLint / CodeQL
12+
- [⚖️ **Gobernanza**](./governance/) — Visión, Roadmap y Requisitos.
13+
- [🏗️ **Arquitectura**](./architecture/) — ADRs, Planos y Modelos C4.
14+
- [🛠️ **Infraestructura**](./infrastructure/) — Docker, K8s y Gateway.
15+
- [🚀 **Operaciones**](./operations/) — Observabilidad y Monitoreo.
16+
- [🎓 **Conocimiento**](./knowledge/) — Onboarding y POCs.
17+
- [💻 **Código Fuente**](./src/) — El "Engine Room" (Apps y Libs).
1318

14-
## Inicio Rapido
19+
---
1520

16-
### Frontend
17-
```bash
18-
npm install
19-
npx nx run apps-web:dev
20-
```
21+
### 🏛️ ADN Técnico
22+
- **Patrones**: Monolito Modular, DDD, Clean Architecture, Hexagonal.
23+
- **Backend**: .NET 8 LTS (Pattern Result, MediatR).
24+
- **Frontend**: React 18 + Vite (Zustand para estado).
25+
- **Seguridad**: Seguridad a Nivel de Fila (RLS) + OAuth2/OIDC.
2126

22-
### Backend (desde apps/api-dotnet/)
23-
```bash
24-
dotnet build
25-
dotnet test
26-
dotnet run --project Ums.Presentation
27-
```
27+
### 🚦 Inicio Rápido
28+
```powershell
29+
# 1. Entrar al Engine Room
30+
cd src
2831
29-
## Documentacion
32+
# 2. Instalar e Iniciar Frontend
33+
npm install; npx nx run app-web:dev
34+
35+
# 3. Compilar Backend
36+
dotnet build ./apps/app-api-dotnet/Ums.sln
37+
```
3038

31-
- [Base de Conocimiento en Ingles](./docs/en/index.md)
32-
- [Base de Conocimientos en Espanol](./docs/es/index.md)
39+
### ⚖️ Gobernanza de Ingeniería
40+
La navegación técnica detallada está disponible en el [**Indice Maestro**](./MASTER_INDEX.es.md). Este proyecto utiliza **BMAD-METHOD** para la trazabilidad documental asistida por IA.

README.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,40 @@
1-
# UMS Monorepo Workspace
1+
# UMS — Enterprise User Management System
22

3-
> **Language:** [English](./README.md) | [Espanol](./README.es.md)
3+
> **High-scale Modular Monolith for Unified Identity & Authorization.**
4+
>
5+
> ![Status](https://img.shields.io/badge/Status-Active-success) ![Arch](https://img.shields.io/badge/Architecture-Modular_Monolith-blue) ![Engine](https://img.shields.io/badge/Engine-.NET_8_/_React-informational)
46
5-
Nx workspace for the User Management System -- .NET 8 backend and React frontend.
7+
---
68

7-
## Tech Stack
9+
### 🚀 Navigation Hub
10+
Explore the repository layers:
811

9-
- **Frontend:** React 18 / Vite / Zustand / TanStack Query
10-
- **Backend:** .NET 8 LTS / ASP.NET Core / MediatR / FluentValidation
11-
- **Data:** PostgreSQL 16 / EF Core (Npgsql)
12-
- **Tooling:** Nx / npm Workspaces / CSharpier / ESLint / CodeQL
12+
- [⚖️ **Governance**](./governance/) — Vision, Roadmap & Requirements.
13+
- [🏗️ **Architecture**](./architecture/) — ADRs, Blueprints & C4 Models.
14+
- [🛠️ **Infrastructure**](./infrastructure/) — Docker, K8s & Gateway.
15+
- [🚀 **Operations**](./operations/) — Observability & Monitoring.
16+
- [🎓 **Knowledge**](./knowledge/) — Onboarding & POCs.
17+
- [💻 **Source Code**](./src/) — The Engine Room (Apps & Libs).
1318

14-
## Quick Start
19+
---
1520

16-
### Frontend
17-
```bash
18-
npm install
19-
npx nx run apps-web:dev
20-
```
21+
### 🏛️ Technical DNA
22+
- **Patterns**: Modular Monolith, DDD, Clean Architecture, Hexagonal.
23+
- **Backend**: .NET 8 LTS (Result Pattern, MediatR).
24+
- **Frontend**: React 18 + Vite (State Management with Zustand).
25+
- **Security**: Row-Level Security (RLS) + OAuth2/OIDC.
2126

22-
### Backend (from apps/api-dotnet/)
23-
```bash
24-
dotnet build
25-
dotnet test
26-
dotnet run --project Ums.Presentation
27-
```
27+
### 🚦 Quick Start
28+
```powershell
29+
# 1. Enter the Engine Room
30+
cd src
2831
29-
## Documentation
32+
# 2. Install & Start Frontend
33+
npm install; npx nx run app-web:dev
34+
35+
# 3. Build Backend
36+
dotnet build ./apps/app-api-dotnet/Ums.sln
37+
```
3038

31-
- [English Knowledge Base](./docs/en/index.md)
32-
- [Base de Conocimientos en Espanol](./docs/es/index.md)
39+
### ⚖️ Engineering Governance
40+
Detailed technical navigation is available in the [**Master Index**](./MASTER_INDEX.md). This project follows the **BMAD-METHOD** for AI-augmented documentation traceability.

src/.nx/workspace-data/d/daemon.log

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -634,3 +634,4 @@ Time taken for 'build typescript dependencies' 8.784099999815226ms
634634
[NX v22.7.1 Daemon Server] - 2026-05-13T21:24:37.253Z - Done responding to the client project-graph
635635
[NX v22.7.1 Daemon Server] - 2026-05-13T21:24:37.253Z - Handled json message REQUEST_PROJECT_GRAPH. Handling time: 0. Response time: 1.
636636
[NX v22.7.1 Daemon Client] - 2026-05-13T21:24:37.251Z - [Messenger] Received message, length: 239650
637+
[NX v22.7.1 Daemon Server] - 2026-05-13T21:24:37.644Z - Closed a connection. Number of open connections: 0

0 commit comments

Comments
 (0)