mirror of
https://github.com/0xJacky/nginx-ui.git
synced 2025-05-11 10:25:52 +02:00
80 lines
2.2 KiB
Markdown
80 lines
2.2 KiB
Markdown
# 專案結構
|
|
|
|
## 根目錄
|
|
|
|
```
|
|
.
|
|
├─ docs # 手冊資料夾
|
|
├─ cmd # 命令列工具
|
|
├─ app # 使用 Vue 3 建構的前端
|
|
├─ resources # 其他資源，不參與建構
|
|
├─ template # 用於 Nginx 的範本檔案
|
|
├─ app.example.ini # 設定檔案的範例
|
|
├─ main.go # 伺服器入口
|
|
└─ ...
|
|
```
|
|
|
|
## 手冊資料夾
|
|
|
|
```
|
|
.
|
|
├─ docs
|
|
│ ├─ .vitepress # 設定資料夾
|
|
│ │ ├─ config
|
|
│ │ └─ theme
|
|
│ ├─ public # 資源
|
|
│ ├─ [language code] # 翻譯，資料夾名為語言代碼，例如 zh_CN, zh_TW
|
|
│ ├─ guide
|
|
│ │ └─ *.md # 手冊 markdown 檔案
|
|
│ └─ index.md # 首頁 markdown 檔案
|
|
└─ ...
|
|
```
|
|
|
|
## 前端
|
|
|
|
```
|
|
.
|
|
├─ app
|
|
│ ├─ public # 公共資源
|
|
│ ├─ src # 原始碼
|
|
│ │ ├─ api # 向後端發起請求的 API
|
|
│ │ ├─ assets # 公共資源
|
|
│ │ ├─ components # Vue 元件
|
|
│ │ ├─ language # 翻譯，使用 vue3-gettext
|
|
│ │ ├─ layouts # Vue 設定
|
|
│ │ ├─ lib # 涵式庫檔案，如幫助函式
|
|
│ │ ├─ pinia # 狀態管理
|
|
│ │ ├─ routes # Vue 路由
|
|
│ │ ├─ views # Vue 檢視
|
|
│ │ ├─ gettext.ts # 定義翻譯
|
|
│ │ ├─ style.css # 整合 tailwind
|
|
│ │ └─ ...
|
|
│ └─ ...
|
|
└─ ...
|
|
```
|
|
|
|
## 後端
|
|
|
|
```
|
|
.
|
|
├─ internal # 內部包
|
|
├─ api # 向前端提供的 API
|
|
├─ model # 資料庫模型
|
|
├─ query # gen 自動生成的資料庫查詢文件
|
|
├─ router # 路由和中介軟體
|
|
├─ settings # 後端設定
|
|
├─ test # 單元測試
|
|
├─ main.go # 主程式入口
|
|
└─ ...
|
|
```
|
|
|
|
## 範本
|
|
|
|
```
|
|
.
|
|
├─ template
|
|
│ ├─ block # Nginx 區塊設定範本
|
|
│ ├─ conf # Nginx 設定範本
|
|
│ └─ template.go # 嵌入範本檔案至後端
|
|
└─ ...
|
|
```
|