Skip to content

Latest commit

 

History

History
235 lines (151 loc) · 5.38 KB

setup.md

File metadata and controls

235 lines (151 loc) · 5.38 KB

安装和启动指南

English Version

[!注意] CSGHub Portal 已将 Web 框架从 Rails 迁移至 Gin。如果您之前使用的是 Rails 版本，请参考最新文档了解如何迁移到 Gin 版本。

鸣谢

本项目基于 Rails、Vue3、Tailwind CSS、Administrate、Postgresql、Apache Arrow、DuckDB 和 GoGin，感谢这些开源项目的支持和贡献！

安装指南

安装 Go

  1. 访问 Go 官方下载页面。

  2. 下载适合您操作系统的 Go 安装包。

  3. 参考 Go 安装指南 进行安装。

  4. 安装完成后，打开终端并运行以下命令验证安装：

    go version

    如果安装成功，您将看到 Go 的版本信息。

安装 Node.js 和 Yarn

  1. 访问 Node.js 官方网站。

  2. 下载并安装适合您操作系统的 LTS（长期支持）版本。

  3. 安装完成后，打开终端并运行以下命令验证安装：

    node --version
npm --version

  4. 安装 Yarn：

    npm install -g yarn

  5. 验证 Yarn 安装：

    yarn --version

设置 Go Path

  1. 确定您的工作空间：选择一个目录作为您的 Go 工作空间，例如 ~/go。

  2. 设置 GOPATH：将以下内容添加到您的 shell 配置文件中（例如 .bashrc 或 .zshrc）

    export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin

  3. 应用更改：运行以下任一命令以确保配置文件更新生效

    source ~/.bashrc
# 或
source ~/.zshrc

  4. 验证设置：运行以下命令以验证 GOPATH 是否正确设置

    go env GOPATH

    输出应为您的工作空间目录，例如 /home/username/go。

设置环境变量（推荐使用 direnv）

  1. 安装 direnv：按照 direnv 官方文档 的说明进行安装。

  2. 配置 direnv：在您的 shell 配置文件（如 .bashrc、.zshrc 等）中添加以下行：

    eval "$(direnv hook bash)"  # 如果使用 bash
# 或
eval "$(direnv hook zsh)"   # 如果使用 zsh

    重新加载您的 shell 配置文件或重启终端。

  3. 创建 .envrc 文件：在项目根目录下，运行：

    cp .envrc.example .envrc

  4. 编辑 .envrc 文件：根据您的需求编辑 .envrc 文件，设置必要的环境变量。例如：

    export CSGHUB_PORTAL_S3_ACCESS_KEY_ID=xxx
export CSGHUB_PORTAL_S3_ACCESS_KEY_SECRET=yyy
# 添加其他需要的环境变量

  5. 允许 direnv 加载 .envrc 文件，在项目根目录下运行：

    direnv allow .

获取 Go 依赖项

安装必要的 Go 模块，需运行：

go mod tidy

安装 Air 用于实时重载

Air 是一个允许 Go 应用程序实时重载的工具。使用以下命令安装：

go install github.com/air-verse/air@latest

获取前端依赖项

打开 frontend 目录并使用 Yarn 安装依赖项：

cd frontend
yarn install

设置数据库

  1. 创建数据库：在您的数据库管理系统中创建一个新的数据库。推荐使用 PostgreSQL，可以使用以下命令

    CREATE DATABASE your_database_name;

    请确保将 your_database_name 替换为您想要使用的实际数据库名称。

  2. 更新 .envrc 文件：确保您的 .envrc 文件中包含正确的数据库连接信息。

  3. 初始化数据库：运行以下命令来初始化数据库

    go run cmd/csghub-portal/main.go migration init

  4. 执行数据库迁移：运行以下命令来执行数据库迁移：

    go run cmd/csghub-portal/main.go migration migrate

启动指南

同时启动前后端服务

要同时启动前后端服务，运行以下命令：

make

单独启动前端服务

如果只想启动前端服务，运行以下命令：

make run-frontend

单独启动 Go 服务

如果只想启动 Go 服务，运行以下命令：

make run-backend

通过 VS Code 启动

  1. 创建 .env 文件：

    • 在项目根目录下，找到 .env.example 文件。
    • 复制 .env.example，并将副本重命名为 .env。
    • 打开 .env 文件，根据您的环境配置填写所有必要的环境变量。
    cp .env.example .env

  2. 编辑 .env 文件：

    • 使用文本编辑器打开 .env 文件。
    • 根据您的开发环境和需求，填写或修改各项配置。
    • 确保所有必要的环境变量都已正确设置。

  3. 在 VS Code 中，打开 “运行和调试” 视图（通常是侧边栏中的播放按钮图标）。

  4. 在顶部的下拉菜单中，您可以选择以下配置之一：

    • "portal": 启动主服务器
    • "init": 初始化数据库
    • "migrate": 执行数据库迁移
    • "rollback": 回滚数据库迁移

通过命令行方式编译项目

  1. 编译项目：

    make build

  2. 运行编译后的可执行文件：

    ./csghub-portal start server

访问应用程序

当两个服务都运行后，打开您的网页浏览器并访问：

http://localhost:8090

您可以查看应用程序进行并进行交互。