tcjlj/flvx
1
0
Fork 0
mirror of https://github.com/Sagit-chu/flvx.git synced 2026-10-07 10:16:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(repo): refresh README Modifications for rewrite scope

Browse Source
This commit is contained in:
Sagit
2026-02-19 07:15:43 +00:00
parent a10c68ef20
commit 0b1609c6cb
1 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -16
View File
@@ -129,27 +129,28 @@ docker compose up -d
- **License**: Apache License 2.0 - **License**: Apache License 2.0
## Modifications ## Modifications
The following major changes and additions have been made in this fork (FLVX): This fork (FLVX) is no longer a light patch on top of the upstream project. It has been deeply reworked, with both backend and frontend rebuilt around a Go-based architecture.
### 1. Backend Architecture (Replaced) ### 1. Backend (Rewritten)
- **Removed**: The original `springboot-backend/` (Java/Spring Boot) has been entirely removed. - **Removed**: The original `springboot-backend/` (Java/Spring Boot) implementation.
- **Added**: A new `go-backend/` (Go/SQLite) implementation replaces the original backend. - **Added**: A fully rewritten `go-backend/` service (Go), including updated data and API handling for panel management.
### 2. Forwarding Agent (Modified) ### 2. Frontend (Reworked)
- **Modified**: `go-gost/` - Modified forwarding agent wrapper. - **Reworked**: `vite-frontend/` has been substantially rebuilt to match the new backend contract and current UI layer architecture.
- **Modified**: `go-gost/x/` - Modified local fork of the `gost` extensions library. - **Updated**: Dashboard pages/components and interaction flows for the current React/Vite stack.
### 3. Frontend (Modified) ### 3. Forwarding Stack (Modified)
- **Modified**: `vite-frontend/` - Significant updates to the React/Vite dashboard to compatible with the new Go backend, including UI/UX improvements (HeroUI + Tailwind). - **Modified**: `go-gost/` forwarding agent wrapper.
- **Modified**: `go-gost/x/` local fork of `github.com/go-gost/x`.
### 4. Mobile Applications (Removed) ### 4. Mobile Clients (Removed)
- **Removed**: `android-app/` - Source code for the Android client. - **Removed**: `android-app/` source code.
- **Removed**: `ios-app/` - Source code for the iOS client. - **Removed**: `ios-app/` source code.
### 5. Infrastructure & Scripts ### 5. Deployment & Project Infrastructure
- **Modified**: `docker-compose.yml` (installer output name, auto-selects IPv4/IPv6 template, updated for Go backend). - **Updated**: Docker deployment templates and installer output flow (IPv4/IPv6 compose variants).
- **Modified**: `install.sh`, `panel_install.sh` (Updated installation logic). - **Updated**: Release installation scripts (`install.sh`, `panel_install.sh`) and supporting automation.
- **Added**: `AGENTS.md` (Project documentation). - **Added/Updated**: Project-level engineering documentation (for example `AGENTS.md`).
--- ---