54 lines
1.8 KiB
Markdown
54 lines
1.8 KiB
Markdown
# Own-Tools | 个人工具箱
|
|
|
|
这是一个基于 Go 语言构建的模块化、全内嵌、响应式个人工具箱。
|
|
|
|
## 🌟 核心特性
|
|
|
|
- **模块化架构**：采用插件化设计（`pkg/base` 接口），后端路由自动注册，前端动态加载工具。
|
|
- **响应式设计**：全站适配桌面端与移动端，具备 Apple 风格的高级质感。
|
|
- **模板驱动**：基于 Go `html/template` 实现布局继承，全站视觉高度统一。
|
|
- **全内嵌部署**：所有前端静态资源、千万级字库数据及字体文件均打包进单个二进制文件。
|
|
- **生产就绪**：支持 Google Analytics 动态注入、Liveness/Readiness 探测、TLS Ingress 自动化部署。
|
|
|
|
## 🛠 已集成工具
|
|
|
|
### [汉字字帖生成器](./pkg/zitie/README.md)
|
|
- **2x3 教学方格**：带圆圈序号、方向箭头、骨架红线。
|
|
- **步进式分解**：9列紧凑米字格，逐笔展示书写过程。
|
|
- **古风竖排信纸**：红色乌丝栏，支持 4 款顶级华光书法字体，智能缺字处理。
|
|
|
|
## 🚀 快速开始
|
|
|
|
### 本地运行
|
|
```bash
|
|
./toolbox -port 8888 -ga G-XXXXXXXXXX
|
|
```
|
|
访问 `http://localhost:8888` 即可使用。
|
|
|
|
### 从源码编译
|
|
```bash
|
|
go build -o toolbox cmd/toolbox/main.go
|
|
```
|
|
|
|
## 🐳 容器化与部署
|
|
|
|
### 环境变量
|
|
- `PORT`: 监听端口（默认 8080）。
|
|
- `GIN_MODE`: 设置为 `release` 以优化性能。
|
|
- `GA_ID`: 动态注入 Google Analytics ID。
|
|
|
|
### K3s 部署
|
|
```bash
|
|
kubectl apply -f deploy/k8s.yaml
|
|
```
|
|
|
|
## 📂 项目结构
|
|
- `cmd/toolbox/`: 程序入口及 web 模板 (`layout.html`, `index.html`)。
|
|
- `pkg/base/`: 核心插件接口定义。
|
|
- `pkg/zitie/`: 汉字字帖功能实现。
|
|
- `deploy/`: Kubernetes 部署清单。
|
|
- `.gitea/`: CI/CD 流水线配置。
|
|
|
|
## 📝 许可证
|
|
MIT License.
|