《GoShip 项目安装与配置指南》

《GoShip 项目安装与配置指南》

1. 项目基础介绍

GoShip 是一个基于 Go 语言的开源项目，它提供了一个功能丰富的起始模板，用于快速开发 SaaS、AI 工具或 Web 应用。该项目旨在通过提供身份验证、支付、电子邮件、通知等基础设施功能，帮助开发者节省时间，快速将项目投入生产。

2. 项目使用的关键技术和框架

• Go：项目的主要编程语言，以其高效的性能和并发能力而闻名。
• HTMX：一个用于增强 HTML 的框架，允许开发者使用标准的 HTML 和 JavaScript 来构建动态界面。
• Ent：一个 Go 语言的 ORM 框架，用于处理数据库模式和代码生成。
• Docker：容器化技术，用于简化项目的部署和运行环境。
• Tailwind CSS：一个功能类优先的 CSS 框架，用于快速UI开发。
• Playwright：一个 Node.js 库，用于进行端到端的 Web 测试。

3. 项目安装和配置的准备工作与详细步骤

准备工作

• 确保您的系统上已安装了以下软件：
  • Go 语言环境
  • Docker
  • Docker Compose
  • make 工具
  • Git（用于克隆项目）

安装步骤

1. 克隆项目到本地：

   git clone https://github.com/leomorpho/goship.git
   cd goship
   

2. 安装项目依赖：

   make init
   

   该命令会设置 Postgres、Redis 和邮件服务容器，构建 JavaScript/CSS 资源，为数据库填充测试用户，并启动项目监视模式。

3. 在项目首次初始化之后，您可以使用以下命令来启动监视模式：

   make watch
   

   监视模式将在后台监视源代码的变化，并自动重新编译和部署应用。

4. 如果需要运行项目的端到端测试，可以使用以下命令：

   make e2eui
   

5. 对于数据库相关的操作，以下是几个有用的 Makefile 命令：

   • 创建新的 Ent 模式文件：

     make ent-new name=YourModelName
     

   • 创建新的迁移文件：

     make makemigrations
     

   • 生成 Ent 代码：

     make ent-gen
     

   • 应用迁移：

     make migrate
     

以上步骤应该可以帮助您成功安装和配置 GoShip 项目。请确保阅读项目的 README 文档以获取更多详细信息，并根据需要调整配置。