README.md

# 中国标准化研究院机构知识库

## 开发前准备

### 配置 IDE

#### 使用 vscode

1. ESLint（作者：Microsoft）
2. Prettier - Code formatter（作者：Prettier）

#### 使用 webstorm

1. 设置 ➡ 语言和框架 ➡ Javascript ➡ 代码质量工具 ➡ ESLint ➡ 勾选自动 ESLint 配置
2. 设置 ➡ 语言和框架 ➡ Javascript ➡ Prettier ➡ 勾选自动 Prettier 配置

### 安装依赖版本要求

```
node  >= 18
npm   >= 10
```

### 安装依赖

```shell
npm install
```

### 激活 huskey

```shell
npm run prepare
```

作用： 向 git 上提交代码时进行前置校验  
校验内容：代码风格（prettier）、编码规范（eslint）、提交日志规范（commitlint）

### 本地运行

```shell
npm run dev
```

### 发布前预览

依赖生产环境的配置文件，即：.env.prod。可在 `package.json` 中的 `scripts.preview` 中修改

```shell
npm run preview
```

### 分析项目依赖关系（可用于项目优化）

```shell
npm run report
```

## 构建

项目支持多环境构建。其中 `.env` 为全量配置，优先使用指定的环境变量文件中配置信息

```shell
# 测试环境，对应环境变量 .env.test
npm run build:test

# 预生产环境，对应环境变量 .env.pre
npm run build:pre

# 生产环境，对应环境变量 .env.prod
npm run build:prod
```

#### 配置本地代理服务api

1. config/useServer.js
2. target 替换 您当前的开发地址