Paragon 项目使用教程
1. 项目目录结构及介绍
Paragon 项目的目录结构如下：
paragon/
├── cmd/
├── devcontainer/
├── docker/
├── ent/
├── graphql/
├── pkg/
├── www/
├── .dockerignore
├── .env
├── .eslintrc.json
├── .gitignore
├── .golangci.yml
├── .goreleaser.yml
├── .reviewdog.yml
├── .travis.yml
├── LICENSE
├── README.md
├── go.mod
├── go.sum
目录介绍
cmd/: 包含项目的命令行工具和入口文件。devcontainer/: 开发容器配置文件。docker/: Docker 相关文件和配置。ent/: 项目的数据库实体定义。graphql/: GraphQL API 相关文件。pkg/: 项目的公共包和库文件。www/: 前端相关文件。.dockerignore: Docker 构建时忽略的文件列表。.env: 环境变量配置文件。.eslintrc.json: ESLint 配置文件。.gitignore: Git 忽略的文件列表。.golangci.yml: GolangCI-Lint 配置文件。.goreleaser.yml: GoReleaser 配置文件。.reviewdog.yml: Reviewdog 配置文件。.travis.yml: Travis CI 配置文件。LICENSE: 项目许可证文件。README.md: 项目介绍和使用说明。go.mod: Go 模块依赖文件。go.sum: Go 模块依赖的校验和文件。
2. 项目启动文件介绍
Paragon 项目的启动文件主要位于 cmd/ 目录下。以下是主要的启动文件：
cmd/main.go: 项目的入口文件，负责初始化项目并启动服务。cmd/server.go: 服务器的启动文件，负责配置和启动 HTTP 服务器。cmd/agent.go: 代理的启动文件，负责配置和启动代理服务。
启动步骤
进入项目根目录。运行 go run cmd/main.go 启动项目。打开浏览器访问 127.0.0.1:80 查看项目运行情况。
3. 项目配置文件介绍
Paragon 项目的配置文件主要位于项目根目录下，以下是主要的配置文件：
.env: 环境变量配置文件，用于设置项目的运行环境变量。.golangci.yml: GolangCI-Lint 配置文件，用于配置代码检查工具。.goreleaser.yml: GoReleaser 配置文件，用于配置项目的发布流程。.reviewdog.yml: Reviewdog 配置文件，用于配置代码审查工具。.travis.yml: Travis CI 配置文件，用于配置持续集成流程。
配置文件示例
.env
# 数据库连接字符串
DATABASE_URL=postgres://user:password@localhost:5432/dbname
# 服务器端口
SERVER_PORT=8080
# 日志级别
LOG_LEVEL=info
.golangci.yml
linters:
enable:
- govet
- golint
- errcheck
disable:
- gocyclo
issues:
exclude-rules:
- path: ".*_test.go"
linters:
- errcheck
.goreleaser.yml
builds:
- env:
- CGO_ENABLED=0
goos:
- linux
- windows
- darwin
goarch:
- amd64
- arm64
.reviewdog.yml
runner:
golangci-lint:
cmd: golangci-lint run --out-format=line-number
format: golangci-lint
level: error
.travis.yml
language: go
go:
- "1.16"
install:
- go get -v ./...
script:
- go test -v ./...
通过以上配置文件，可以灵活地配置和调整 Paragon 项目的运行环境和构建流程。