diff --git a/backend/expressjs/readme.md b/backend/expressjs/readme.md index 007b364..40dd8a3 100644 --- a/backend/expressjs/readme.md +++ b/backend/expressjs/readme.md @@ -17,7 +17,7 @@ last_updated: 2026-03-23 --- This document outlines the **best practices** for Express.js architecture. The framework is highly unopinionated, meaning strict adherence to these 30 rules is critical for maintaining the cleanliness and security of enterprise code. -# Context & Scope +# 🎯 Context & Scope - **Primary Goal:** Provide a strict MVC architectural framework and 30 patterns for creating secure Express.js APIs. - **Target Tooling:** AI agents (Cursor, Windsurf, Copilot) and Senior Developers. - **Tech Stack Version:** Express 4.x / 5.x diff --git a/backend/graphql/readme.md b/backend/graphql/readme.md index 0c51e47..72b6911 100644 --- a/backend/graphql/readme.md +++ b/backend/graphql/readme.md @@ -17,7 +17,7 @@ last_updated: 2026-03-29 --- This document establishes **best practices** for building and maintaining GraphQL APIs. These constraints guarantee a scalable, highly secure, and deterministic architecture suitable for an enterprise-level, production-ready backend. -# ⚙️ Context & Scope +# 🎯 Context & Scope - **Primary Goal:** Provide an uncompromising set of rules and architectural constraints for GraphQL API environments. - **Target Tooling:** AI-agents (Cursor, Windsurf, Copilot, Antigravity) and Senior Developers. - **Tech Stack Version:** Agnostic diff --git a/backend/microservices/readme.md b/backend/microservices/readme.md index d2c7821..023aa25 100644 --- a/backend/microservices/readme.md +++ b/backend/microservices/readme.md @@ -18,7 +18,7 @@ last_updated: 2026-03-27 > [!IMPORTANT] > This document establishes **best practices** for designing and maintaining a Microservices architecture. These constraints guarantee a scalable, highly secure, and deterministic system suitable for an enterprise-level, production-ready backend. -# ⚙️ Context & Scope +# 🎯 Context & Scope - **Primary Goal:** Provide an uncompromising set of rules and architectural constraints for distributed system environments. - **Target Tooling:** AI-agents (Cursor, Windsurf, Copilot, Antigravity) and System Architects. - **Tech Stack Version:** Agnostic diff --git a/backend/mongodb/readme.md b/backend/mongodb/readme.md index 416864e..57a6c1e 100644 --- a/backend/mongodb/readme.md +++ b/backend/mongodb/readme.md @@ -17,7 +17,7 @@ last_updated: 2026-03-28 --- This document establishes **best practices** for building and maintaining MongoDB databases. These constraints guarantee a scalable, highly secure, and deterministic architecture suitable for an enterprise-level, production-ready backend. -# ⚙️ Context & Scope +# 🎯 Context & Scope - **Primary Goal:** Provide an uncompromising set of rules and architectural constraints for MongoDB environments. - **Target Tooling:** AI-agents (Cursor, Windsurf, Copilot, Antigravity) and Senior Database Administrators. - **Tech Stack Version:** MongoDB 7.0+ diff --git a/backend/nodejs/architecture.md b/backend/nodejs/architecture.md index d723fc9..b8f043c 100644 --- a/backend/nodejs/architecture.md +++ b/backend/nodejs/architecture.md @@ -12,7 +12,7 @@ last_updated: 2026-03-24 [⬅️ Back to Parent](./readme.md) -## ⚙️ Context & Scope +## 🎯 Context & Scope This document strictly enforces the deterministic architectural boundaries and structural patterns for Node.js backend systems. ```mermaid diff --git a/backend/nodejs/readme.md b/backend/nodejs/readme.md index bc898fe..560cedb 100644 --- a/backend/nodejs/readme.md +++ b/backend/nodejs/readme.md @@ -17,7 +17,7 @@ last_updated: 2026-03-23 --- This document establishes **best practices** for building and maintaining Node.js applications. These constraints guarantee a scalable, highly secure, and deterministic architecture suitable for an enterprise-level, production-ready backend. -# ⚙️ Context & Scope +# 🎯 Context & Scope - **Primary Goal:** Provide an uncompromising set of rules and architectural constraints for pure Node.js environments. - **Target Tooling:** AI-agents (Cursor, Windsurf, Copilot, Antigravity) and Senior Developers. - **Tech Stack Version:** Node.js 24+ diff --git a/backend/nodejs/security-best-practices.md b/backend/nodejs/security-best-practices.md index 301c880..a3d4092 100644 --- a/backend/nodejs/security-best-practices.md +++ b/backend/nodejs/security-best-practices.md @@ -12,7 +12,7 @@ last_updated: 2026-03-24 [⬅️ Back to Parent](./readme.md) -## ⚙️ Context & Scope +## 🎯 Context & Scope This document outlines the strict security configurations and anti-patterns that must be mitigated in a production Node.js environment. --- diff --git a/backend/postgresql/readme.md b/backend/postgresql/readme.md index 428615a..1577d40 100644 --- a/backend/postgresql/readme.md +++ b/backend/postgresql/readme.md @@ -17,7 +17,7 @@ last_updated: 2026-03-27 --- This document establishes **best practices** for building and maintaining PostgreSQL databases. These constraints guarantee a scalable, highly secure, and deterministic architecture suitable for an enterprise-level, production-ready backend. -# ⚙️ Context & Scope +# 🎯 Context & Scope - **Primary Goal:** Provide an uncompromising set of rules and architectural constraints for PostgreSQL environments. - **Target Tooling:** AI-agents (Cursor, Windsurf, Copilot, Antigravity) and Senior Database Administrators. - **Tech Stack Version:** PostgreSQL 16+ diff --git a/backend/readme.md b/backend/readme.md index e4d22e1..e8a0406 100644 --- a/backend/readme.md +++ b/backend/readme.md @@ -12,7 +12,7 @@ last_updated: 2026-03-22 [🏠 Back to Home](../README.md) -# Context & Scope +# 🎯 Context & Scope - **Primary Goal:** Outline the overarching philosophy and standards for Backend and system development inside the ecosystem. - **Target Tooling:** Cursor, Windsurf, Antigravity. - **Tech Stack Version:** Agnostic @@ -23,7 +23,7 @@ last_updated: 2026-03-22 **The foundational rules and standards governing backend logic.** --- -## Architecture Principles +## 🧱 Core Principles - Adhere to the defined [Architectural Patterns](../../architectures/readme.md) when building applications, specifically Hexagonal Architecture / Clean Architecture. - Avoid tightly coupling business domains to framework-specific libraries. @@ -74,3 +74,21 @@ app.get('/users/:id', async (req, res) => { ### 🚀 Solution Never allow Database Object Relational Mapping (ORM) models to bleed into standard HTTP responses. Always map through a DTO. + +## 2. 🗂️ Architectural Workflow + +```mermaid +graph TD + A[Client Request] --> B[Controller] + B --> C[DTO Mapper] + C --> D[ORM/Database] + + classDef default fill:#e1f5fe,stroke:#03a9f4,stroke-width:2px,color:#000; + classDef component fill:#e8f5e9,stroke:#4caf50,stroke-width:2px,color:#000; + classDef layout fill:#f3e5f5,stroke:#9c27b0,stroke-width:2px,color:#000; + + class A layout; + class B component; + class C component; + class D component; +``` diff --git a/backend/redis/readme.md b/backend/redis/readme.md index 4e94a9a..8c2b02b 100644 --- a/backend/redis/readme.md +++ b/backend/redis/readme.md @@ -17,7 +17,7 @@ last_updated: 2026-03-27 --- This document establishes **best practices** for building and maintaining Redis data stores. These constraints guarantee a scalable, highly secure, and deterministic architecture suitable for an enterprise-level, production-ready backend. -# ⚙️ Context & Scope +# 🎯 Context & Scope - **Primary Goal:** Provide an uncompromising set of rules and architectural constraints for Redis environments. - **Target Tooling:** AI-agents (Cursor, Windsurf, Copilot, Antigravity) and Senior Backend Developers. - **Tech Stack Version:** Redis 7+