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

History

MHSanaei 745e394c74 refactor(panel): rename injected globals + collapse QR modal entries Rename the SPA globals injected by Go to drop the ad-hoc dunder shape and free up the bare `webBasePath` name (still the DB setting key) from colliding with the JS global it used to share: window.__X_UI_BASE_PATH__ -> window.X_UI_BASE_PATH window.__X_UI_CUR_VER__ -> window.X_UI_CUR_VER Also rework the QR-Code modal to fold every QR (subscription + JSON sub URL, share links, WireGuard config/peer links) into a single a-collapse with one panel per QR. Subscription panels are listed first and open by default; everything else stays collapsed so a multi-link inbound no longer scrolls forever.		2026-05-10 23:40:39 +02:00
..
src	refactor(panel): rename injected globals + collapse QR modal entries	2026-05-10 23:40:39 +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	refactor(panel): rename injected globals + collapse QR modal entries	2026-05-10 23:40:39 +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").