先决条件

Canyon 是一个JavaScript代码覆盖率解决方案，打包为一组 Docker 容器。您可以在任何可以运行Docker Engine 的操作系统上安装并运行 Canyon 。

系统要求

Canyon 设计为在小型和大型部署中都能良好运行。运行 Canyon 的最低要求是操作系统支持 Docker 和 1 个 CPU 核心 + 2GB RAM。

安装 Node.js、npm、pnpm

Node.js + npm

安装 Node.js (opens in a new tab) (v18+) 和 npm (opens in a new tab) (v9+).

• Node.js + npm 安装手册 (opens in a new tab)

pnpm

安装 pnpm (opens in a new tab) (v6+).

• pnpm 安装手册 (opens in a new tab)

Docker

安装 Docker (opens in a new tab) (v20+).

• Docker 安装手册 (opens in a new tab)

Postgres数据库

Canyon 使用 Postgres 数据库来存储基础数据。您可以使用您选择的任何 Postgres 数据库提供商 - 托管在本地或云提供商上。确保您拥有以下格式的有效 Postgres 数据库 URL：

postgresql://username:password@url:5432/dbname

MongoDB数据库

Canyon 使用 MongoDB 数据库来存储覆盖率详细数据。您可以使用您选择的任何 MongoDB 数据库提供商 - 托管在本地或云提供商上。确保您拥有以下格式的有效 MongoDB 数据库 URL：

mongodb://username:password@url:27017/dbname

创建表

pnpm run migrate

安装和构建

了解如何安装和构建 Canyon 社区版。

配置环境

在开始安装之前，您需要配置环境变量。

.env.example将克隆存储库根目录中找到的文件内容复制到.env环境变量并添加您的值。

确保环境值不包含在引号内。

# Prisma Config
DATABASE_URL=postgress://canyon:canyon@localhost:5432/canyon
 
MONGODB_URL=mongodb://canyon:canyon@localhost:27017/canyon
 
# Gitlab Config
GITLAB_URL="***"
GITLAB_CLIENT_ID="***"
GITLAB_CLIENT_SECRET="***"
PRIVATE_TOKEN=***
 
REDIRECT_URI=http://localhost:3000/login
 

让我们来了解一下主要的环境变量：

1. DATABASE_URL: 在此处添加 Postgres 数据库 URL。
2. MONGODB_URL: 在此处添加 MongoDB 数据库 URL。
3. GITLAB_URL: gitlab的URL。例如：https://gitlab.com.
4. GITLAB_CLIENT_ID: 从 Gitlab OAuth 配置中获取的客户端 ID。
5. GITLAB_CLIENT_SECRET: 从 Gitlab OAuth 配置中获取的客户端密钥。
6. PRIVATE_TOKEN: 申请一个私有令牌，以便在 Gitlab 上执行操作。
7. REDIRECT_URI: 重定向 URI 用于 OAuth。

gitlab的配置可以按照gitlab配置 OAuth 指南 (opens in a new tab)

Node.js

克隆项目

git clone https://github.com/canyon-project/canyon

安装依赖项并构建项目

pnpm install && pnpm run build

修改.env文件，使用nodejs运行项目

node packages/canyon-backend/dist/main.js

Docker

使用docker运行canyon只需要指定环境变量文件路径和端口号即可

docker run -d -p 8080:8080 -v /your/path/.env:/app/.env zhangtao25/canyon:main

启动成功

启动成功后会有三个主要的服务：

• Canyon frontend
• Canyon backend

访问 http://localhost:8080 以查看 Canyon 的主页。