Files
antd-admin/apps/docs/content/en/getting-started/folder-structure.mdx
T
4dc473ba55 refactor(api): modular defineApi layer with shared API_PREFIX (#1181)
* refactor(api): introduce defineApi + axios request layer

Replace ad-hoc fetch httpClient with api/request.ts (axios interceptors,
envelope unwrap, auth refresh) and defineApi-based resource modules.
Move session hydration into api/auth, sync both templates, and update docs.

Co-authored-by: zuiidea <zuiiidea@gmail.com>

* chore: unify Cursor rules, fix monorepo install hooks, refresh basic docs

Add root preinstall to set githooks and disable parallel vp config git lock races; merge per-app Cursor thin rules into app.mdx; keep template READMEs free of monorepo-only paths and describe basic as default English rather than English-only.

Co-authored-by: Cursor <cursoragent@cursor.com>

* chore: add root turbo fmt and format app sources

Expose fmt via turbo at the monorepo root, apply Oxfmt in basic/with-lingui, and run vp staged through pnpm exec in pre-commit so hooks work without a global vp.

Co-authored-by: Cursor <cursoragent@cursor.com>

* chore: drop root eslint/prettier and bump turbo to 2.11.9

Root formatting and lint stay on turbo fmt/lint via Vite+ in workspace apps.

Co-authored-by: Cursor <cursoragent@cursor.com>

* chore: consolidate agent guidance into AGENTS.md

Merge scoped instructions into per-app AGENTS.md, add monorepo AGENTS.md and add-resource skill, and remove template .github Copilot files plus the Cursor app router rule.

Co-authored-by: Cursor <cursoragent@cursor.com>

* chore(basic): add add-resource skill and portable app-root paths

Align basic with with-lingui for CRUD scaffolding via AGENTS.md and .agents/skills, and drop hardcoded monorepo paths in agent docs.

Co-authored-by: Cursor <cursoragent@cursor.com>

* refactor(api): split modules under shared/ with API_PREFIX

Move auth and users into folder modules, centralize path constants, and align MSW with endpoint paths in both template apps.

Co-authored-by: Cursor <cursoragent@cursor.com>

* docs: document modular API layer in README files

Expand template READMEs with src/api layout, fix CLI table and E2E script references.

Co-authored-by: Cursor <cursoragent@cursor.com>

* docs: align site with modular src/api layout

Document API_PREFIX, folder structure, templates, and E2E script usage in en/zh.

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: zuiidea <zuiidea@example.com>
2026-10-22 23:13:22 +08:00

51 lines
1.5 KiB
Plaintext

---
title: Folder Structure
description: Key directories and responsibilities in the repository
---
# Folder Structure
```text
.
├─ apps/
│ ├─ basic/
│ ├─ with-lingui/
│ └─ docs/
├─ packages/
├─ pnpm-workspace.yaml
└─ turbo.json
```
## Directory Guide
- `apps/basic`: Main admin template (English)
- `apps/with-lingui`: Admin template with Lingui i18n
- `apps/docs`: Documentation site (Nextra + Next.js)
- `packages`: Shared packages and utilities
## Template app `src/` (basic / with-lingui)
Both templates share the same layout; **with-lingui** adds `src/locales/` and Lingui scripts.
```text
src/
├── api/
│ ├── request.ts # Transport (axios, defineApi, token refresh)
│ ├── schemas.ts # Compatibility re-exports
│ ├── shared/ # API_PREFIX, pagination, params, menu helpers
│ ├── auth/ # Auth paths, schemas, login / hydrateSession
│ └── users/ # User CRUD, query keys, path constants
├── components/
├── hooks/
├── mocks/ # MSW handlers (same path constants as api modules)
├── routes/
├── stores/
└── utils/ # Constants, menu tree — not HTTP transport
```
See **[Proxying API Requests](/en/backend/proxying-api-requests)** for the API layer and MSW/backend wiring.
## Recommendation
When creating reusable logic, prioritize placing it in `packages` rather than duplicating in app folders.