Alex-Devera/3x-ui
1
0
Fork 0
mirror of https://github.com/MHSanaei/3x-ui.git synced 2026-06-06 21:24:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
3x-ui/frontend
History
MHSanaei 281e2d3d57
build(frontend): drop deprecated rimraf/glob/inflight transitive deps 
vue3-persian-datetime-picker pinned moment-jalaali to ^0.9.4, which
pulled rimraf@3 → glob@7 → inflight@1. inflight in particular leaks
memory and is unmaintained. Override moment-jalaali to ^0.10.4 (same
runtime API, dropped the legacy build deps) so npm install no longer
warns and the dep tree is 12 packages lighter.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-09 14:22:25 +02:00
..
src build(frontend): bump eslint to 10 + add flat config + clean lint warnings 2026-05-09 02:36:47 +02:00
.gitignore build(frontend): Phase 2 — scaffold Vite + Vue 3 + AD-Vue 4 2026-05-08 10:36:03 +02:00
eslint.config.js build(frontend): bump eslint to 10 + add flat config + clean lint warnings 2026-05-09 02:36:47 +02:00
inbounds.html revert(frontend): keep entry HTML files at frontend/ root 2026-05-09 02:36:26 +02:00
index.html revert(frontend): keep entry HTML files at frontend/ root 2026-05-09 02:36:26 +02:00
login.html revert(frontend): keep entry HTML files at frontend/ root 2026-05-09 02:36:26 +02:00
package-lock.json build(frontend): drop deprecated rimraf/glob/inflight transitive deps 2026-05-09 14:22:25 +02:00
package.json build(frontend): drop deprecated rimraf/glob/inflight transitive deps 2026-05-09 14:22:25 +02:00
README.md docs(frontend): rewrite README for multi-page Vue 3 layout 2026-05-09 03:58:46 +02:00
settings.html revert(frontend): keep entry HTML files at frontend/ root 2026-05-09 02:36:26 +02:00
subpage.html revert(frontend): keep entry HTML files at frontend/ root 2026-05-09 02:36:26 +02:00
vite.config.js revert(frontend): keep entry HTML files at frontend/ root 2026-05-09 02:36:26 +02:00
xray.html revert(frontend): keep entry HTML files at frontend/ root 2026-05-09 02:36:26 +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

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