52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
# Frontend Monorepo Template
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A **scalable, enterprise-ready Web & Desktop monorepo** built with **Turborepo**, **pnpm**, **Vite**, and **Electron**.
|
|
This repository is designed for long-term maintainability, featuring shared logic and UI libraries, centralized tooling configuration, turbo-powered task orchestration, and native desktop distribution with auto-updates.
|
|
|
|
---
|
|
|
|
## 🌍 Global Context
|
|
|
|
This repository utilizes a monorepo architecture to seamlessly share core systems, business logic, and UI components across multiple distribution targets (Web, Desktop, and Landing Page).
|
|
|
|
### Topology Overview
|
|
|
|
* **`apps/`**: Deployable applications (`web`, `desktop`, `landing`, `docs-dev`).
|
|
* **`packages/`**: Shared libraries and core engines (`core-api`, `core-storage`, `ui`, `utils`, `configs`, etc.).
|
|
|
|
---
|
|
|
|
## 📚 Single Source of Truth
|
|
|
|
> [!IMPORTANT]
|
|
> **Internal Documentation Hub**
|
|
> All documentation, installation guides, architectural deep-dives, and API references are hosted internally via our VitePress application.
|
|
|
|
* **View in Git Repository (Raw Markdown):** [Read Overview Documentation](apps/docs-dev/src/overview.md)
|
|
* **Run Documentation Locally:**
|
|
|
|
If this is your first time running the documentation, ensure you install the dependencies first:
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
Then, start the documentation server:
|
|
```bash
|
|
pnpm dev:docs-dev
|
|
```
|
|
|
|
---
|
|
|
|
## 📝 License
|
|
|
|
This project is **private and proprietary**.
|