Ptt-Alertor 项目使用教程
1. 项目目录结构及介绍
Ptt-Alertor/
├── aws/
├── channels/
├── command/
├── connections/
├── controllers/
├── jobs/
├── models/
├── myutil/
├── ptt/
├── public/
├── session/
├── shorturl/
├── storage/
├── testing/
├── .dockerignore
├── .env.example
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── ecs-deploy
├── go.mod
├── go.sum
├── logo.jpg
└── main.go
目录结构介绍
- aws/: 与AWS相关的文件和配置。
- channels/: 消息通道相关的文件和配置。
- command/: 命令行相关的文件和配置。
- connections/: 数据库连接相关的文件和配置。
- controllers/: 控制器相关的文件和配置。
- jobs/: 任务调度相关的文件和配置。
- models/: 数据模型相关的文件和配置。
- myutil/: 自定义工具类相关的文件和配置。
- ptt/: PTT相关的文件和配置。
- public/: 公共资源文件。
- session/: 会话管理相关的文件和配置。
- shorturl/: 短链接相关的文件和配置。
- storage/: 存储相关的文件和配置。
- testing/: 测试相关的文件和配置。
- .dockerignore: Docker忽略文件。
- .env.example: 环境变量示例文件。
- .gitignore: Git忽略文件。
- Dockerfile: Docker构建文件。
- LICENSE: 项目许可证。
- README.md: 项目说明文件。
- ecs-deploy: ECS部署相关的文件。
- go.mod: Go模块依赖文件。
- go.sum: Go模块依赖校验文件。
- logo.jpg: 项目Logo图片。
- main.go: 项目启动文件。
2. 项目启动文件介绍
main.go
main.go
是项目的启动文件,负责初始化项目并启动服务。以下是 main.go
的基本结构:
package main
import (
"fmt"
"log"
"net/http"
"Ptt-Alertor/controllers"
"Ptt-Alertor/models"
"Ptt-Alertor/myutil"
)
func main() {
// 初始化数据库连接
models.InitDB()
// 初始化路由
http.HandleFunc("/", controllers.HomeHandler)
http.HandleFunc("/boards", controllers.BoardsHandler)
http.HandleFunc("/articles", controllers.ArticlesHandler)
// 启动HTTP服务
log.Println("Starting server on :8080")
if err := http.ListenAndServe(":8080", nil); err != nil {
log.Fatal(err)
}
}
主要功能
- 初始化数据库连接: 调用
models.InitDB()
初始化数据库连接。 - 初始化路由: 设置HTTP路由,将请求分发到不同的处理函数。
- 启动HTTP服务: 启动HTTP服务,监听8080端口。
3. 项目的配置文件介绍
.env.example
.env.example
是环境变量配置文件的示例,实际使用时需要复制为 .env
并根据实际情况填写。
# 数据库连接配置
DB_HOST=localhost
DB_PORT=5432
DB_USER=user
DB_PASSWORD=password
DB_NAME=dbname
# 服务端口
PORT=8080
# 其他配置
DEBUG=true
主要配置项
- DB_HOST: 数据库主机地址。
- DB_PORT: 数据库端口。
- DB_USER: 数据库用户名。
- DB_PASSWORD: 数据库密码。
- DB_NAME: 数据库名称。
- PORT: 服务监听端口。
- DEBUG: 调试模式开关。
使用方法
- 复制
.env.example
为.env
。 - 根据实际情况填写
.env
中的配置项。 - 启动项目时,配置项会自动加载到环境变量中。
以上是 Ptt-Alertor 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你快速上手该项目。