Workout Tracker 项目使用教程

Workout Tracker 项目使用教程

workout-tracker A workout tracking web application for personal use (or family, friends), geared towards running and other GPX-based activities 项目地址: https://gitcode.com/gh_mirrors/wo/workout-tracker

1. 项目目录结构及介绍

Workout Tracker 的目录结构如下：

workout-tracker/
├── .github/
├── .gitignore
├── .golangci.yml
├── .prettierrc.json
├── assets/
├── cmd/
│   └── workout-tracker/
├── docker-compose.*
├── docs/
├── go.mod
├── go.sum
├── LICENSE
├── Makefile
├── pkg/
├── postgres.env
├── README.md
├── screenshots.js
├── tailwind.config.js
├── translations/
├── vendor/
├── views/
└── workout-tracker.example.yaml

• .github/: 存放 GitHub 专用的配置文件。
• .gitignore: 定义 Git 忽略的文件和目录。
• .golangci.yml: Go 语言代码风格和错误检查配置文件。
• .prettierrc.json: 代码格式化配置文件。
• assets/: 存放静态资源，如 CSS、JavaScript 文件等。
• cmd/: 存放启动项目的命令行工具。
• docker-compose.*: Docker Compose 配置文件，用于定义服务、网络和卷。
• docs/: 存放项目文档。
• go.mod: Go 依赖管理文件。
• go.sum: Go 模块校验文件。
• LICENSE: 项目许可证文件。
• Makefile: 用于构建和部署项目的 Makefile 文件。
• pkg/: 存放项目的业务逻辑和库。
• postgres.env: PostgreSQL 数据库环境变量配置文件。
• README.md: 项目说明文件。
• screenshots.js: 项目截图的 JavaScript 文件。
• tailwind.config.js: Tailwind CSS 配置文件。
• translations/: 存放项目多语言支持文件。
• vendor/: 存放项目依赖的第三方库。
• views/: 存放 HTML 模板文件。
• workout-tracker.example.yaml: 项目配置文件示例。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/workout-tracker/main.go。这个文件包含了创建和运行 HTTP 服务器的逻辑。以下是启动文件的主要内容：

package main

import (
    "fmt"
    "net/http"
    "workout-tracker/pkg/server"
)

func main() {
    // 初始化服务器配置
    s := server.NewServer()
    // 启动服务器
    fmt.Println("Server starting on port 8080...")
    if err := http.ListenAndServe(":8080", s.Handler()); err != nil {
        fmt.Println("Server start error:", err)
    }
}

这里，server.NewServer() 用于创建一个新的服务器实例，http.ListenAndServe() 用于启动服务器并监听 8080 端口。

3. 项目的配置文件介绍

项目的配置文件是 workout-tracker.example.yaml。这个文件包含了项目运行时需要的配置项，例如：

jwt_encryption_key: "your-secret-key"
wt_bind: "[::]:8080"
wt_logging: "true"
wt_debug: "false"

• jwt_encryption_key: 用于加密 JWT 令牌的密钥。必须提供，否则每次启动服务器时都会生成一个新的密钥，导致现有会话无效。
• wt_bind: 服务器绑定到的地址和端口。
• wt_logging: 是否启用日志记录。
• wt_debug: 是否启用调试模式。

在实际部署时，你可以根据需要创建一个新的配置文件，例如 workout-tracker.yaml，并复制 workout-tracker.example.yaml 中的内容，然后修改为你自己的配置。或者在环境变量中设置相应的配置项。

workout-tracker A workout tracking web application for personal use (or family, friends), geared towards running and other GPX-based activities 项目地址: https://gitcode.com/gh_mirrors/wo/workout-tracker