# 作业平台前端

**Repository Path**: zjuaces/platform

## Basic Information

- **Project Name**: 作业平台前端
- **Description**: 作业平台
git 地址：https://github.com/TencentBlueKing/bk-job/tree/v3.7.6-rc.1
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-14
- **Last Updated**: 2025-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# BridgeKube JOB 

## 简介

BridgeKube JOB 是一个基于 Vue.js 框架的前端项目，用于展示 BridgeKube 平台的功能和数据。

## 使用说明

### 本地开发

为了便于调试和开发，Job 提供了两种本地开发模式：HTTP 服务模式和 HTTPS 服务模式。

#### 1. 本地 HTTP 服务模式

* 启动 HTTP 服务
``` bash
npm run dev
```

* 环境文件配置
```
// 在项目的 /frontend 目录下创建一个名为 .env.development 的环境配置文件，并在其中配置 API 请求的域名，例如：
// 配置 api 域名
AJAX_URL_PREFIX = "http://api.xxx.yyy.com"
```

#### 2. 本地 HTTPS 服务模式

* 启动 HTTPS 服务
``` bash
npm run dev-external
```

* 环境文件配置
```
// 在项目的 /frontend 目录下创建一个名为 .env.development 的环境配置文件，并在其中配置 API 请求的域名，例如：
// 配置 API 域名
AJAX_URL_PREFIX = "https://api.xxx.yyy.com"
```

> 提示： 确保 .env.development 和 .env.external 文件正确配置了域名地址，以便与后端服务正常通信。 对于 HTTPS 模式，需要确保域名配置指向支持 HTTPS 的后端 API 服务。

### 研发环境构建
生产环境构建用于生成项目的静态资源文件，供部署到 Web 服务器上运行。

* 构建生产环境资源
``` bash
npm run build
```

* 输出内容

    构建完成后，生成的静态资源文件会存储在 dist 目录下，包括：
```
index.html：项目的入口 HTML 文件。
/static：静态资源文件目录（如 CSS 和图片）。
/js：打包生成的 JavaScript 文件。 
```

### 容器镜像编译构建

生产环境构建用于生成项目的容器镜像，供部署到容器平台（如 Docker 或 Kubernetes）上运行。需要在 Dockerfile 中配置相应的构建指令并且在特定的编译环境中进行镜像构建。

* 构建容器镜像
```shell
make image
```

* 容器镜像推送
```shell
make push
```

* 容器镜像清理
```shell
make clean
```

### 注意事项

* Node.js 版本要求： 请确保使用支持的 Node.js 版本（建议 16.x 及以上）来运行项目。
* 环境变量管理： 环境变量文件如 .env.development 和 .env.external 是项目的重要组成部分，用于配置运行时依赖的 API 域名。请根据环境的不同，正确设置这些变量。
* 依赖安装： 项目首次启动前，需在项目根目录下执行以下命令安装依赖：npm install
* 构建优化： 生产环境构建过程中，项目会通过 Webpack 等工具对资源进行压缩和优化，以减小资源体积和提升加载速度。

### 支持和反馈

* 如果在使用过程中遇到问题，请联系维护团队或提交问题到项目的 Issue 页面。
* 维护团队联系方式：
  * 组织: 浙江大学 ACES 实验室
  * 维护者: ai-liuys@outlook.com