docs: update README with technical manual aesthetic details

This commit is contained in:
Antigravity AI 2026-04-19 10:58:21 +07:00
parent 7376a655c4
commit 6a37da1ae5

View file

@ -1,16 +1,43 @@
# React + Vite
# VNDANGKHOA PORTAL
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
> **A reference manual for people who design and build software.**
Currently, two official plugins are available:
Welcome to the central routing and access layer for the VNDK network environment. The portal has been structurally architected to reflect a highly professional, physical **Technical Reference Manual**, complete with custom animated isometric and flat orthographic vector schematics.
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
## 🗂️ System Architecture
## React Compiler
This interface acts as the definitive directory for all persistent nodes within the ecosystem:
* **PRIMARY**: Centralized directory logic, routing to professional Showcase (Portfolio) and Archive (CV) paths.
* **MEDIA_DISTRIBUTION**: High-fidelity streaming environments for digital consumption (Spotify, Netflix, YouTube).
* **SYSTEM_MAINTENANCE**: Unlocked kernel-level access terminals to the REDMAGIC hardware modification and patching local nodes.
* **DEVELOPMENT_STACK**: Native compilation logic and file manipulation toolchains (Rasterization, PDF serialization, Shell execution).
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
## 🛠️ Stack Components
## Expanding the ESLint configuration
The portal leverages modern build primitives to ensure rendering speed and layout precision:
* **Core**: React + Vite
* **Aesthetics**: Tailwind CSS (featuring custom Pixel Perfect blueprint styling)
* **Typography**: PT Serif, IBM Plex Mono, Silkscreen
* **Animation Engine**: Framer Motion (powering the 2D/2.5D schematic animations)
If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.
## 🚀 Execution Protocols
To instantiate the local development environment:
```bash
# 1. Install dependencies
npm install
# 2. Boot the development server
npm run dev
# 3. Compile for production routing
npm run build
```
## 📐 Blueprint Engine
All visual data diagrams exist as pure, inline SVG components. These are located in `src/components/illustrations/` and use mathematical transformations (like `scale(1, 0.5) rotate(45)`) combined with `<motion.path>` libraries to achieve a true, lightweight "holographic blueprint" aesthetic devoid of heavy rasterized limits.
---
*© 2026 REPRODUCED PIXEL PERFECT. Managed and illustrated by Khoa Vo.*