GoShip 项目使用与配置指南

GoShip 项目使用与配置指南

goship Opinionated Go/HTMX boilerplate with payments, emails, auth, notifications and more!⛵️ 项目地址: https://gitcode.com/gh_mirrors/gos/goship

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

GoShip 项目的目录结构设计合理，便于开发者快速理解和上手。以下是主要目录和文件的介绍：

• cmd: 包含程序的入口和主要逻辑，分为 web（Web 服务器）、worker（异步任务处理）和 seed（数据库初始化）。
• config: 存储非敏感的配置变量，并定义了配置的 Go 结构体。
• pkg: 项目的主要包，包括 context（处理请求上下文）、controller（处理请求和响应）、domain（项目特有领域对象）、funcmap（自定义模板函数）、htmx（HTMX 生命周期辅助）、middleware（中间件）、repos（数据仓库）、routes（路由定义）、services（服务层）、tasks（任务定义）、tests（测试工具）、types（结构体类型）和 templates（HTML 模板）。
• ent: 使用 Ent ORM 框架定义的数据库模型和生成的代码。
• static: 存放静态文件，如图片、CSS 和 JavaScript 文件。
• javascript: 存放 JavaScript 应用程序代码。
• build.mjs: JavaScript 的构建脚本。
• .env: 存放敏感环境变量的文件。
• .kamal: Kamal 部署钩子，用于部署过程中运行命令。
• .github: GitHub Actions 工作流和秘密配置。
• .gitignore: 指定 Git 忽略的文件。
• tailwind.config.js: Tailwind CSS 配置文件。
• tsconfig.json: TypeScript 配置文件。
• Procfile: 定义项目在监视模式下运行的命令。
• service-worker.js: PWA 的服务工作者脚本。
• pwabuilder-ios-wrapper: PWA iOS 包装器，用于推送通知的参考。
• Makefile: 项目的主要入口点，用于构建、运行和部署项目。

2. 项目的启动文件介绍

项目的启动主要通过 Makefile 文件来管理。以下是几个主要的启动命令：

• make init: 初始化项目，包括设置数据库、Redis、邮件服务容器，构建 JavaScript/CSS 资产，以及填充数据库测试用户。
• make watch: 在监视模式下运行项目，实时重新构建更改的资产。
• make: 直接运行项目，不包含监视模式。

3. 项目的配置文件介绍

项目的配置主要通过 .env 文件和 config 目录下的配置文件来管理。

• .env: 包含敏感的环境变量，如数据库密码、API 密钥等。
• config 目录: 包含非敏感配置，如数据库连接信息、服务端口等。这里的配置通过 Go 结构体来定义，并在应用启动时加载。

确保在开始之前正确设置这些配置文件，这对于项目的正常运行至关重要。

goship Opinionated Go/HTMX boilerplate with payments, emails, auth, notifications and more!⛵️ 项目地址: https://gitcode.com/gh_mirrors/gos/goship