WhatGotDone 项目教程

WhatGotDone 项目教程

whatgotdoneA tool for sharing weekly task updates with teammates.项目地址:https://gitcode.com/gh_mirrors/wh/whatgotdone

1. 项目目录结构及介绍

WhatGotDone 项目的目录结构如下：

whatgotdone/
├── .github/
│   └── workflows/
├── backend/
│   ├── cmd/
│   ├── internal/
│   ├── pkg/
│   └── Dockerfile
├── frontend/
│   ├── public/
│   ├── src/
│   ├── Dockerfile
│   └── package.json
├── .gitignore
├── Dockerfile
├── Makefile
├── README.md
└── go.mod

目录结构介绍

• .github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• backend/: 后端代码目录，包含 Go 语言编写的后端服务。
  • cmd/: 存放应用程序的入口文件。
  • internal/: 存放内部包，通常是项目的核心逻辑。
  • pkg/: 存放可重用的包。
  • Dockerfile: 后端服务的 Docker 配置文件。
• frontend/: 前端代码目录，包含 React 编写的前端应用。
  • public/: 存放静态资源文件。
  • src/: 存放前端源代码。
  • Dockerfile: 前端服务的 Docker 配置文件。
  • package.json: 前端项目的依赖管理文件。
• .gitignore: Git 忽略文件配置。
• Dockerfile: 项目的 Docker 配置文件。
• Makefile: 项目的构建和部署脚本。
• README.md: 项目说明文档。
• go.mod: Go 模块依赖管理文件。

2. 项目启动文件介绍

WhatGotDone 项目的启动文件主要位于 backend/cmd/ 目录下。以下是主要的启动文件：

• backend/cmd/whatgotdone/main.go: 这是后端服务的入口文件，负责启动整个后端服务。

启动文件介绍

• main.go: 该文件包含了应用程序的 main 函数，负责初始化配置、启动 HTTP 服务器等。

3. 项目配置文件介绍

WhatGotDone 项目的配置文件主要包括以下几个部分：

• .env: 环境变量配置文件，通常用于存储敏感信息和运行时配置。
• Makefile: 项目的构建和部署脚本，包含了一些常用的命令，如 make build、make run 等。
• go.mod: Go 模块依赖管理文件，定义了项目的依赖库。

配置文件介绍

• .env: 该文件用于配置环境变量，例如数据库连接字符串、API 密钥等。
• Makefile: 该文件包含了项目的构建和部署命令，可以通过 make 命令来执行。
• go.mod: 该文件定义了项目的依赖库，可以通过 go mod tidy 命令来管理依赖。

以上是 WhatGotDone 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。

whatgotdoneA tool for sharing weekly task updates with teammates.项目地址:https://gitcode.com/gh_mirrors/wh/whatgotdone