Compare commits

...

2 Commits

Author SHA1 Message Date
ee2e890c39 docs(readme): 补充完整项目 README 文档
- 增加项目简介及基于 Gin 框架说明
- 详细描述项目目录结构及文件作用
- 提供技术栈信息及版本要求
- 添加快速开始指导,涵盖依赖安装与运行方式
- 说明前台、后台及API路由接口及访问路径
- 介绍控制器层继承关系及基础响应方法
- 说明模板系统使用及示例
- 描述静态资源目录及访问方式
- 详列配置项及开发规范要求
- 增加常见问题及解决方案帮助开发者快速上手
2026-02-20 13:41:12 +08:00
543f33dad6 docs(readme): 补充完整项目 README 文档
- 增加项目简介及基于 Gin 框架说明
- 详细描述项目目录结构及文件作用
- 提供技术栈信息及版本要求
- 添加快速开始指导,涵盖依赖安装与运行方式
- 说明前台、后台及API路由接口及访问路径
- 介绍控制器层继承关系及基础响应方法
- 说明模板系统使用及示例
- 描述静态资源目录及访问方式
- 详列配置项及开发规范要求
- 增加常见问题及解决方案帮助开发者快速上手
2026-02-20 13:39:03 +08:00
2 changed files with 397 additions and 2 deletions

231
FUN.md Normal file
View File

@@ -0,0 +1,231 @@
# 🎉 程序员快乐指南
> 写代码就像谈恋爱,你永远不知道下一个 Bug 会在哪里出现。
---
## 🐛 Bug 的六种境界
| 境界 | 描述 | 程序员状态 |
|------|------|-----------|
| 第一层 | 代码能跑,但不知道为啥 | 😅 懵懂 |
| 第二层 | 代码不能跑,但知道为啥 | 🤔 清醒 |
| 第三层 | 代码能跑,也知道为啥 | 😊 自信 |
| 第四层 | 代码不能跑,也不知道为啥 | 😭 崩溃 |
| 第五层 | 代码昨天能跑,今天不能跑 | 🤯 怀疑人生 |
| 第六层 | 代码没动,自己好了 | 👻 见鬼了 |
---
## 💬 程序员经典语录
- "这不是 Bug这是特性"
- "在我电脑上好好的啊..."
- "重启试试?"
- "肯定是缓存问题"
- "下个版本再修"
---
## 🎯 编程语言选择指南
```
想快速上手?→ Python
想找工作? → Java
想装X → Haskell
想折磨自己? → C++
想全都要? → 做梦
```
---
## 🍕 程序员食物链
```
架构师
|
技术负责人
|
高级工程师
|
中级工程师
|
初级工程师
|
实习生
|
写代码的猫🐱
|
Stack Overflow
```
---
## ⏰ 程序员时间估算
| 你说的时间 | 实际时间 | 客户理解 |
|-----------|---------|---------|
| 5 分钟 | 2 小时 | 明天 |
| 1 小时 | 1 天 | 下周 |
| 1 天 | 1 周 | 下个月 |
| 1 周 | 1 月 | 明年 |
| 1 月 | 项目取消 | 从未存在 |
---
## 🔧 调试艺术
```go
// 初级程序员
fmt.Println("到这里了1")
fmt.Println("到这里了2")
fmt.Println("到这里了3")
// 中级程序员
log.Printf("debug: var=%v", variable)
// 高级程序员
// 盯着代码看 5 分钟,删掉一行,好了
// 大神
// 瞟一眼,"哦,少了个分号"
```
---
## 🎮 程序员日常 RPG
```
【任务】修复生产环境 Bug
【难度】⭐⭐⭐⭐⭐
【奖励】加班 + 老板的感谢 + 下次还找你
【任务】重构祖传代码
【难度】⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐
【奖励】精神崩溃 + 想辞职
【任务】写文档
【难度】⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐
【奖励】无(没人会看)
```
---
## 🌈 代码注释的艺术
```go
// 初级
// 这里是加法
a + b
// 中级
// 计算两个数的和
a + b
// 高级
// 别动,动了就崩
a + b
// 大神
// TODO: 这里有问题,但我懒得修
a + b
// 佛系
// 一切随缘
a + b
```
---
## 🎵 程序员之歌
```
🎶 在那山的那边海的那边
有一群程序员
他们老实又胹腆
他们聪明又没钱
他们一天到晚坐在那里熬夜写代码
饿了就咬一口方便面~
哦 可爱的程序员
哦 可怜的程序员
只要一改需求他们就要重新搞一遍
但是期限只剩下两天~
```
---
## 🏆 程序员成就系统
- [x] 写出没有 Bug 的代码(运行一次)
- [x] 在 Stack Overflow 找到答案
- [x] 复制粘贴代码并运行成功
- [x] 解释自己三个月前写的代码
- [ ] 在截止日前完成任务
- [ ] 产品经理不改需求
- [ ] 写出完美的注释
- [ ] 让客户满意
- [ ] 准时下班
---
## 🧙‍♂️ 程序员咒语
```
rm -rf /
😱 千万别试!
sudo !!
上条命令加权限,救急神器
ctrl + c, ctrl + v
程序员的核心技能
ctrl + z
后悔药,但现实中没有
```
---
## 💡 人生哲理
> "如果代码能运行,就不要动它。"
>
> "注释里的 TODO永远是 TODO。"
>
> "最好的代码是没有代码。"
>
> "过早优化是万恶之源。"
>
> "程序员最讨厌的两件事:
> 1. 别人不写注释
> 2. 别人让自己写注释"
---
## 🎬 程序员电影分级
- **G级**: 《社交网络》- 创业真美好
- **PG级**: 《硅谷》- 搞笑又心酸
- **R级**: 看自己的代码审查记录
- **X级**: 看生产环境的错误日志
---
*最后,记住程序员的终极奥义:*
```
if (code.Works()) {
dont.Touch()
}
```
**Happy Coding!** 🚀
---
*本文档仅供娱乐,如有雷同,说明你也是程序员。*

168
README.md
View File

@@ -1,3 +1,167 @@
# GoCode # GoCode Web 项目
Go语言学习 基于 Gin 框架的 Go Web 应用程序。
## 项目结构
```
.
├── controller/ # 控制器层
│ ├── admin/ # 后台管理控制器
│ │ ├── articleController.go # 文章管理
│ │ ├── indexController.go # 后台首页
│ │ └── userController.go # 用户管理
│ ├── api/ # API 接口控制器
│ │ └── apiController.go # API 接口
│ └── nannanwu/ # 前台控制器
│ ├── baseController.go # 基础控制器
│ └── defaultController.go # 默认控制器
├── router/ # 路由配置
│ ├── adminRouter.go # 后台路由
│ ├── apiRouter.go # API 路由
│ └── defaultRouter.go # 默认路由
├── static/ # 静态资源
│ ├── footer.css # 底部样式
│ ├── navbar.css # 导航栏样式
│ └── style.css # 全局样式
├── templates/ # HTML 模板
│ ├── layout/ # 布局模板
│ │ ├── base.html # 基础布局
│ │ ├── footer.html # 底部模板
│ │ └── navbar.html # 导航栏模板
│ └── pages/ # 页面模板
│ ├── index.html # 首页
│ ├── test.html # 测试页
│ └── user.html # 用户页
├── main.go # 程序入口
├── go.mod # Go 模块配置
└── go.sum # Go 依赖校验
```
## 技术栈
- **框架**: [Gin](https://github.com/gin-gonic/gin) v1.11.0
- **语言**: Go 1.25+
- **模板**: Go HTML Template
## 快速开始
### 1. 安装依赖
```bash
go mod tidy
```
### 2. 运行项目
```bash
go run main.go
```
或编译后运行:
```bash
go build -o app.exe .
./app.exe
```
### 3. 访问应用
- 前台首页: http://localhost:8088/
- 后台管理: http://localhost:8088/admin
- API 接口: http://localhost:8088/api
## 路由说明
### 前台路由 (`/`)
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `/` | 首页 |
| GET | `/article` | 文章详情 |
| GET | `/success` | 成功页面 |
| GET | `/error` | 错误页面 |
### 后台路由 (`/admin`)
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `/admin` | 后台首页 |
| GET | `/admin/login` | 登录页面 |
| GET | `/admin/plist` | 列表页面 |
| GET | `/admin/article` | 文章列表 |
| GET | `/admin/user` | 用户列表 |
| GET | `/admin/user/:id` | 用户详情 |
### API 路由 (`/api`)
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `/api` | API 首页 |
| GET | `/api/user` | 用户信息 |
| GET | `/api/plist` | 用户列表 |
## 控制器说明
### BaseController
提供基础的响应方法:
- `Success()` - 返回成功响应
- `Error()` - 返回错误响应
### 继承关系
```
BaseController
└── DefaultController (继承 BaseController)
```
## 模板系统
使用 Go 的 `html/template`,支持模板继承:
- **基础模板**: `layout/base.html`
- **页面模板**: 继承 base 模板,填充 `content` block
示例:
```html
{{ define "layout/base" }}
{{ block "content" . }}{{ end }}
{{ end }}
```
## 静态资源
静态文件位于 `/static` 目录,通过 `/static/` 路径访问:
- CSS: `/static/style.css`
- 导航栏样式: `/static/navbar.css`
- 底部样式: `/static/footer.css`
## 配置说明
- **端口**: 8088 (在 `main.go` 中修改)
- **模板路径**: `templates/**/*`
- **静态资源**: `./static` 映射到 `/static`
## 开发规范
1. **控制器**: 按功能模块分组,放在 `controller/`
2. **路由**: 每个模块独立路由文件,统一在 `router/` 管理
3. **模板**: 布局模板放 `layout/`,页面模板放 `pages/`
4. **静态资源**: CSS 放 `static/`,按功能分文件
## 常见问题
### 编译错误: missing go.sum entry
```bash
go mod tidy
```
### 端口被占用
修改 `main.go` 中的端口号:
```go
r.Run(":8088") // 修改为其他端口
```