mirror of https://github.com/MHSanaei/3x-ui.git synced 2026-05-13 13:58:22 +00:00

History

MHSanaei 444b05cac9 perf(frontend): code-split heavy components to improve LCP Switch the inbounds-page modals, login page's theme switch, and the Persian date picker to defineAsyncComponent. They're not needed on first paint, so deferring them shrinks the initial bundle and lets the LCP element render sooner. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>		2026-05-10 11:33:46 +02:00
..
src	perf(frontend): code-split heavy components to improve LCP	2026-05-10 11:33:46 +02:00
.gitignore	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
eslint.config.js	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
inbounds.html	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
index.html	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
login.html	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
nodes.html	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
package-lock.json	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
package.json	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
README.md	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
settings.html	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
subpage.html	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00
vite.config.js	fix(panel): make webBasePath work end-to-end in dev and prod	2026-05-09 21:47:37 +02:00
xray.html	Vue3 migration (#4198 )	2026-05-09 17:47:35 +02:00

README.md

3x-ui frontend

Vue 3 + Ant Design Vue 4 + Vite. Multi-page app — one HTML entry per panel route — built into ../web/dist/ and embedded into the Go binary via embed.FS.

Dev

npm install
npm run dev

Vite serves on http://localhost:5173/. API calls and /panel/* routes proxy to the Go panel at http://localhost:2053/, so start the Go panel first (go run main.go) and then Vite.

The proxy auto-rewrites /panel, /panel/settings, /panel/inbounds, /panel/xray to the matching Vite-served HTML in dev mode (see MIGRATED_ROUTES in vite.config.js), so the sidebar's production-style links work without round-tripping through Go.

Production build

npm run build

Outputs to ../web/dist/ (HTML at the root, hashed JS/CSS under assets/). The Go binary embeds this directory at compile time and web/controller/dist.go serves the per-page HTML.

Lint

npm run lint

ESLint 10 with eslint.config.js (flat config) — vue3-recommended plus a few rule overrides for the project's formatting style.

Layout

frontend/
├── *.html                 # Vite entry HTML, one per panel route
├── eslint.config.js
├── vite.config.js
└── src/
    ├── entries/           # Per-page bootstrap (createApp + mount)
    ├── pages/             # One folder per route, each with the page
    │   ├── index/         # component + helpers + sub-components
    │   ├── login/
    │   ├── inbounds/
    │   ├── xray/
    │   ├── settings/
    │   └── sub/
    ├── components/        # Cross-page Vue components
    ├── composables/       # Reusable reactive logic (useTheme, …)
    ├── api/               # Axios setup, CSRF interceptor
    ├── i18n/              # vue-i18n init (locales live in web/translation/)
    ├── models/            # Inbound, Outbound, Status, … domain classes
    └── utils/             # HttpUtil, ObjectUtil, LanguageManager, …

Adding a new page

Add frontend/<page>.html referencing /src/entries/<page>.js.
Add src/entries/<page>.js that imports the page component and mounts it.
Add the page component under src/pages/<page>/.
Register the entry in rollupOptions.input in vite.config.js.
If the page is reachable from the sidebar at /panel/<route>, add it to MIGRATED_ROUTES so the dev proxy serves the Vite HTML.
Wire the Go controller to serveDistPage(c, "<page>.html").