开源项目启动和配置教程

1. 项目的目录结构及介绍

staffjoy 项目是一个开源项目，下面是该项目的目录结构及其简要介绍：

staffjoy/
├── api/                   # 包含API相关的代码和文档
│   ├── auth/              # 认证相关的API代码
│   ├── company/           # 公司信息相关的API代码
│   ├── department/        # 部门信息相关的API代码
│   ├── employee/          # 员工信息相关的API代码
│   ├── position/          # 职位相关的API代码
│   └── shift/             # 班次相关的API代码
├── cmd/                   # 主程序入口
│   └── staffjoy/          # staffjoy服务的主程序
├── config/                # 配置文件
├── deployments/           # 部署相关的脚本和配置
├── docs/                  # 项目文档
├── internal/              # 内部服务实现的代码
│   ├── auth/              # 认证服务实现代码
│   ├── company/           # 公司信息服务实现代码
│   ├── department/        # 部门信息服务实现代码
│   ├── employee/          # 员工信息服务实现代码
│   ├── position/          # 职位信息服务实现代码
│   └── shift/             # 班次信息服务实现代码
├── pkg/                   # 公共库和工具代码
├── scripts/               # 项目构建和运维脚本
├── test/                  # 测试相关的代码和文档
└── tools/                 # 辅助工具代码

2. 项目的启动文件介绍

项目的启动文件位于 cmd/staffjoy/main.go。这是项目的主入口文件，负责初始化服务、加载配置、设置路由和启动HTTP服务。

package main

import (
    "staffjoy/internal"
)

func main() {
    // 初始化配置
    internal.InitConfig()

    // 设置路由
    internal.InitRouter()

    // 启动HTTP服务
    internal.StartServer()
}

3. 项目的配置文件介绍

项目的配置文件位于 config/config.toml，这是一个TOML格式的配置文件。以下是配置文件的主要内容：

[server]
  http_port = 8080  # HTTP服务的端口
  https_port = 8443 # HTTPS服务的端口

[database]
  driver = "postgres"  # 数据库驱动
  source = "postgres://user:password@localhost/staffjoy?sslmode=disable" # 数据库连接字符串

[auth]
  jwt_secret = "your_secret_key" # JWT认证的密钥

[logging]
  level = "info" # 日志级别
  format = "json" # 日志格式

在启动项目之前，需要确保配置正确的数据库连接信息、JWT密钥等，以确保项目能正确连接到数据库并进行身份验证。