GitHub 账号配置

GitHub 是一个代码托管平台，在 Ship Vibany 项目中，我们使用 GitHub 来存储和管理代码，并与 Vercel 集成实现自动部署。本指南将帮助您配置 GitHub 账号并设置项目仓库。

创建 GitHub 账号

如果您还没有 GitHub 账号，请按照以下步骤创建：

访问 GitHub 官网
点击右上角的 "Sign up" 按钮
填写用户名、电子邮件和密码
完成验证步骤
选择免费计划（Free）
完成账号设置

使用模板创建项目仓库

Ship Vibany 项目已设置为模板仓库，您可以直接使用该模板创建自己的项目：

访问 Vibany Next 模板仓库
确认您有访问权限（如果没有，请联系管理员）
点击仓库页面右上角的 "Use this template" 按钮
选择 "Create a new repository"
填写您的仓库名称（例如 "my-vibany-site"）
选择仓库可见性（建议选择 "Private"）
点击 "Create repository from template" 按钮

配置 SSH 密钥（可选但推荐）

配置 SSH 密钥可以让您更安全地与 GitHub 仓库交互：

打开终端（Mac/Linux）或 Git Bash（Windows）

生成 SSH 密钥：

ssh-keygen -t ed25519 -C "your_email@example.com"

按照提示完成密钥生成

将 SSH 密钥添加到 SSH 代理：

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519

复制公钥内容：
```
cat ~/.ssh/id_ed25519.pub
```
在 GitHub 中添加 SSH 密钥：
- 访问 GitHub 设置页面
- 点击左侧的 "SSH and GPG keys"
- 点击 "New SSH key"
- 填写标题并粘贴公钥内容
- 点击 "Add SSH key"

克隆您的项目仓库

在使用模板创建自己的仓库后，您可以将代码克隆到本地进行开发：

克隆您的项目仓库：

git clone https://github.com/your-username/my-vibany-site.git
cd my-vibany-site

或者使用 SSH（如果已配置）：

git clone git@github.com:your-username/my-vibany-site.git
cd my-vibany-site

同步模板更新

为了方便将来同步原始模板仓库的更新，建议创建一个专门用于同步的分支：

创建并切换到同步分支：
```
git checkout -b sync
```

添加原始模板仓库作为上游远程仓库：

git remote add upstream https://github.com/vibany-shipping/vibany-next.git

从上游仓库获取更新：

git fetch upstream
git merge upstream/main

解决可能出现的冲突，然后推送到您的同步分支：
```
git push origin sync
```
之后可以通过拉取请求（Pull Request）将更新合并到您的主分支。

自动同步更新（可选）

您也可以使用 GitHub Actions 自动同步上游仓库的更新：

在您的仓库中创建 .github/workflows/sync.yml 文件，内容如下：

name: Sync with upstream

on:
  schedule:
    - cron: '0 0 * * 0'  # 每周日运行
  workflow_dispatch:  # 允许手动触发

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          ref: sync
      - name: Sync with upstream
        run: |
          git remote add upstream https://github.com/vibany-shipping/vibany-next.git
          git fetch upstream
          git merge upstream/main
          git push origin sync

这将每周自动同步更新到您的 sync 分支，您可以根据需要合并这些更新。

GitHub 与 Vercel 集成

在将代码推送到 GitHub 仓库后，您需要将其与 Vercel 集成以实现自动部署：

登录 Vercel
点击 "Add New..." 然后选择 "Project"
选择 "Import Git Repository"
授权 Vercel 访问您的 GitHub 账号（如果尚未授权）
选择您刚创建的仓库（例如 my-vibany-site）
重要：在部署前，确保所有必要的环境变量已配置好
- 检查项目根目录下的 .env.example 文件，了解需要配置的环境变量
- 在 Vercel 项目设置中添加这些环境变量
点击 "Deploy" 按钮

完成上述步骤后，每当您推送代码到 GitHub 仓库的主分支时，Vercel 将自动部署最新版本。

GitHub 最佳实践

定期提交代码，使用清晰的提交信息
使用分支进行功能开发和测试
不要在代码仓库中存储敏感信息（如 API 密钥），使用环境变量
使用 .gitignore 文件排除不需要版本控制的文件
定期从模板仓库同步更新以获取最新功能和安全修复
在进行重大更改前创建分支，确保可以安全回滚
使用 Pull Request 进行代码审查，确保代码质量