How nxpatterns/enterprise-software-architecture works
Project Type and Purpose
• This is a documentation & tooling repository (“Elvis”) built around Nx workspaces, Angular, NestJS, and related technologies.
• It serves two roles:
a. A content platform (Markdown articles, PDFs, SVG assets) for tutorials and best practices.
b. A toolkit (Python scripts, Node/NPM config) to automate and modernize existing Nx-based Angular/NestJS projects (e.g., fixing webpack configs).
File‑Structure Analysis
• Root level
• package.json – NPM scripts and dependencies (e.g., markdown linters, build tooling)
• .gitignore, .gitattributes, .vscode – VCS and editor config
• /articles
• Organized by topic: Angular, JavaScript, Nest.js, Nx, TypeScript
• Contains both placeholder dirs (.gitkeep) and ready‐to‐read PDFs (e.g., Quick‑Start guides)
• /assets/svg
• /scripts/python/webpack-related-issues
• A set of Python utilities to programmatically modify Nx workspace JSON, package.json, project.json
• Automates “use local package,” “update version,” “remove from config,” etc.
Key Points from README
• “Elvis” is both the brand and the ongoing documentation project for enterprise‑grade Nx workspaces.
• The first deliverable: “NestJS for Angular Experts” tutorial (found under articles/Nest.js…).
• The author’s goal: steadily expand this knowledge base and the accompanying automation tools.
a. Main Components
• Content Repository
– Markdown articles, PDFs, SVG assets
• Tooling Engine
– Python script modules for workspace/config automation
– NPM scripts (as entry points)
• Local Authoring Environment
– VSCode + markdownlint (per .markdownlint.json)
– Node.js runtime + Python runtime
• External Nx Workspace (Target Projects)
– Repositories that get modified by the Python scripts
• CI/Publishing Pipeline (optional)
– GitHub Actions or another CI to lint, build, and deploy docs (e.g., to GitHub Pages)
b. Relationships & Data Flows
1. Author edits Markdown in /articles and SVG in /assets/svg.
2. Local tooling
– NPM scripts invoke markdownlint & previewers
– Python scripts read/write target project files (nx.json, package.json)
3. Version Control
– Changes pushed to GitHub (“webia1/elvis”)
4. CI/Publishing
– On push: lint → build static site → deploy to hosting
c. Architectural Patterns & Principles
• Separation of Concerns:
• Content vs. tooling scripts vs. assets
• Modular Tooling:
• Each Python script addresses a single config‐tweaking task
• Convention over Configuration:
• Scripts assume Nx workspace layout (nx.json, project.json locations)
• Extensibility:
• New tutorial topics → create new subfolders under /articles
• New automation tasks → add new Python modules under scripts/
d. Key Technologies & Frameworks
• Markdown + PDF for content
• SVG for vector assets
• Python 3.x for workspace automation
• Node.js + NPM for linting & possible static‐site toolchain
• Nx (implicitly, as the external target)