Skip to content

Commit a984cb9

Browse files
committed
Fix: add Prettier configuration for consistent code formatting.
1 parent 168943a commit a984cb9

34 files changed

+2648
-2718
lines changed

.dockerignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ venv
4040
temp
4141
tmp
4242
tput
43-
43+
api/local/data.json
4444

4545

4646
docs

.editorconfig

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false
14+
15+
[Makefile]
16+
indent_style = tab

.prettierrc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"printWidth": 80,
3+
"tabWidth": 2,
4+
"useTabs": false,
5+
"singleQuote": true,
6+
"trailingComma": "es5",
7+
"bracketSpacing": true,
8+
"jsxBracketSameLine": false,
9+
"semi": true,
10+
"arrowParens": "avoid"
11+
}

.vercelignore

+1
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
/Dockerfile
33
/install.sh
44
/LICENSE
5+
/docs

README.md

+74-70
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,46 @@
11
<div align="center">
22
<img src="./docs/images/logo.png" alt="logo.png" style="zoom:30%;" />
33

4-
5-
64
# API CHECKE
75

86
</div>
97

108
> [!TIP]
119
> 点击体验 : https://check.crond.dev
1210
13-
14-
15-
## 纯前端 API 检测工具
11+
## 纯前端 API 检测工具
1612

1713
-**支持各种 OpenAI API 中转服务的测活**
14+
1815
- 兼容 oneapi、newapi 等中转 OpenAI 格式的 API,全面检测可用性。
1916

2017
- 🔒 **纯前端版本,数据更安全**
18+
2119
- 所有操作均在前端完成,无需担心网络超时,确保数据安全。
2220

2321
- 📊 **详细的测活数据**
22+
2423
- 显示响应时间、模型一致性等信息,测试结果一目了然。
2524

2625
- 💾 **云端存储与本地存**
26+
2727
- **云端存储**:配置可保存至云端,实现多设备共享。
2828
- **本地存储**:常用配置本地保存,快速加载,方便快捷。
2929

3030
- 🌙 **主题和语言切换**
31+
3132
- **深色/浅色模式**:根据喜好选择适合的主题,保护视力。
3233
- **多语言支持**:支持中文和英文,满足不同语言需求。
3334

3435
- 🖥️ **多种部署方式**
3536
- **Vercel 部署**:支持一键部署到 Vercel,方便快捷。
36-
- **Docker 部署**
37+
- **Docker 部署**
3738
- **Cloudflare 部署**
3839

3940
## 📦开始使用
41+
4042
### vercel 部署
43+
4144
1. 点击右侧按钮开始部署:
4245
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/october-coder/api-check&env=PASSWORD&project-name=api-check&repository-name=api-check),直接使用 Github 账号登录即可,记得在环境变量页填入 后端密码
4346
2. 部署完毕后,即可开始使用;
@@ -52,21 +55,19 @@
5255
docker run -d -p 13000:13000 \
5356
-e PASSWORD=you_password \
5457
-v you_path:/app/data \
55-
--name api-check ghcr.io/rickcert/api-check:latest
58+
--name api-check ghcr.io/rickcert/api-check:latest
5659
```
5760

58-
59-
6061
### cloudflare 部署后端
62+
6163
1. 参考 [详细教程](./docs/cloudflare.md)
6264
2. 最好绑定自定义域名
63-
6465

65-
## 📜最近更新
66+
## 📜最近更新
6667

6768
<img src="./docs/images/testing.png" alt="测试" style="zoom:50%;" />
6869

69-
### v2.0.0
70+
### v2.0.0
7071

7172
🔔 **全新特性与优化**
7273

@@ -75,9 +76,9 @@
7576
- **本地存储**:提供本地缓存功能,快捷保存到本地,避免重复输入,提高使用效率。
7677
- **数据管理**:新增设置面板,方便管理本地和云端的配置数据。
7778
-**支持预设参数**
78-
- **一键配置方便**
79-
- **快速绑定到new-api**
80-
- 💻 **支持 Vercel Docker一键部署**
79+
- **一键配置方便**
80+
- **快速绑定到new-api**
81+
- 💻 **支持 Vercel Docker一键部署**
8182
- 🌙 **新增暗黑模式**
8283
- **主题切换**:支持深色模式和浅色模式的切换,适应不同环境和用户偏好。
8384
- **自动适配**:可以根据系统设置自动切换主题,保护您的视力。
@@ -86,13 +87,13 @@
8687
- 📱 **移动端适配优化**
8788
- 🛠 **其他优化和修复**
8889

89-
### 🧪 版本历史
90+
### 🧪 版本历史
9091

9192
<details>
9293

93-
### v1.5.0
94+
### v1.5.0
9495

95-
- 📱 适配手机模式
96+
- 📱 适配手机模式
9697
- 🌙 新增暗黑主题
9798
- 🧠 优化o1模型测试
9899

@@ -120,7 +121,6 @@
120121
- 📋 实现模型列表获取
121122
</details>
122123

123-
124124
## 📋 功能介绍
125125

126126
- 🧪 测试多个模型的可用性和一致性
@@ -131,77 +131,80 @@
131131
- 💾 云端存储和本地缓存
132132
- 🌙 主题和语言切换
133133
- 🛠 高级验证功能
134+
134135
- **官转 验证**:验证 API 的真实性,查看系统指纹。
135-
136136
- **温度验证**:验证模型的随机性和稳定性。
137-
138137
- **函数调用验证**:测试模型的函数调用能力。
139-
138+
140139
### 🛠 云端存储
141140

142141
- **docker 部署** 后端url 请使用 https://your_website/api
143142
- **vercel 部署** 后端url 请使用 https://your_website/api
144-
- **Cloudflare部署** 后端url 请使用 https://your_website
143+
- **Cloudflare部署** 后端url 请使用 https://your_website
145144

146145
### 🛠 预设参数设置
147146

148147
<img src="./docs/images/config.png" alt="上测试报告" style="zoom:50%;" />
149148

150149
🔗 url
151150

152-
- **描述**: API 接口地址。
153-
- **示例**: `"url": "https://api.example.com"`
151+
- **描述**: API 接口地址。
152+
- **示例**: `"url": "https://api.example.com"`
154153

155154
📦 models
156155

157-
- **描述**: 模型名称数组,表示可以使用的模型。
158-
- **示例**: `"models": ["model1", "model2"]`
156+
- **描述**: 模型名称数组,表示可以使用的模型。
157+
- **示例**: `"models": ["model1", "model2"]`
159158

160159
⏱ timeout
161160

162-
- **描述**: 请求超时时间(以秒为单位)。
163-
- **示例**: `"timeout": 30`
161+
- **描述**: 请求超时时间(以秒为单位)。
162+
- **示例**: `"timeout": 30`
164163

165164
🔁 concurrency
166165

167-
- **描述**: 并发请求的数量。
168-
- **示例**: `"concurrency": 5`
169-
170-
🚫 closeAnnouncement **方便中转站使用**
171-
172-
- **描述**: 是否关闭公告显示。设置为 `true` 时关闭公告显示,设置为 `false` 或未定义时显示公告。 **方便中转站使用**
173-
- **示例**: `"closeAnnouncement": true`
174-
175-
```
176-
https://check.crond.dev/?settings={"key":"*sk*","url":"*api*","models":["gpt-4o-mini","gpt-4o"],"timeout":10,"concurrency":2,"closeAnnouncement":true}
177-
```
178-
解码后的 JSON 字符串如下:
179-
```json
180-
{
181-
"key": "your_api_key",
182-
"url": "https://api.example.com",
183-
"models": ["gpt-4o-mini", "gpt-4o"],
184-
"timeout": 10,
185-
"concurrency": 2,
186-
"closeAnnouncement": true
187-
}
188-
```
189-
- **voapi** 示例
190-
191-
```
192-
{
193-
"name": "check",
194-
"link": "https://check.crond.dev/?settings={%22key%22:%22*sk*%22,%22url%22:%22*api*%22,%22models%22:[%22gpt-4o-mini%22],%22timeout%22:10,%22concurrency%22:2,%22closeAnnouncement%22:true}",
195-
"icon": "https://check.crond.dev/logo.png"
196-
}
197-
```
198-
- **newapi** 示例
199-
200-
```
201-
{
202-
"CHECK": "https://check.crond.dev/?settings={\"key\":\"{key}\",\"url\":\"{address}\",\"models\":[\"gpt-4o-mini\"],\"timeout\":10,\"concurrency\":2,\"closeAnnouncement\":true}"
203-
}
204-
```
166+
- **描述**: 并发请求的数量。
167+
- **示例**: `"concurrency": 5`
168+
169+
🚫 closeAnnouncement **方便中转站使用**
170+
171+
- **描述**: 是否关闭公告显示。设置为 `true` 时关闭公告显示,设置为 `false` 或未定义时显示公告。 **方便中转站使用**
172+
- **示例**: `"closeAnnouncement": true`
173+
174+
```
175+
https://check.crond.dev/?settings={"key":"*sk*","url":"*api*","models":["gpt-4o-mini","gpt-4o"],"timeout":10,"concurrency":2,"closeAnnouncement":true}
176+
```
177+
178+
解码后的 JSON 字符串如下:
179+
180+
```json
181+
{
182+
"key": "your_api_key",
183+
"url": "https://api.example.com",
184+
"models": ["gpt-4o-mini", "gpt-4o"],
185+
"timeout": 10,
186+
"concurrency": 2,
187+
"closeAnnouncement": true
188+
}
189+
```
190+
191+
- **voapi** 示例
192+
193+
```
194+
{
195+
"name": "check",
196+
"link": "https://check.crond.dev/?settings={%22key%22:%22*sk*%22,%22url%22:%22*api*%22,%22models%22:[%22gpt-4o-mini%22],%22timeout%22:10,%22concurrency%22:2,%22closeAnnouncement%22:true}",
197+
"icon": "https://check.crond.dev/logo.png"
198+
}
199+
```
200+
201+
- **newapi** 示例
202+
203+
```
204+
{
205+
"CHECK": "https://check.crond.dev/?settings={\"key\":\"{key}\",\"url\":\"{address}\",\"models\":[\"gpt-4o-mini\"],\"timeout\":10,\"concurrency\":2,\"closeAnnouncement\":true}"
206+
}
207+
```
205208

206209
### 🛠 **高级验证功能**
207210

@@ -219,6 +222,7 @@
219222
3. 🎯 根据官方api参考值,检测命中率
220223

221224
### 🛠生成报告
225+
222226
<img src="./docs/images/report.png" alt="上测试报告" style="zoom:50%;" />
223227

224228
## 🤝 贡献
@@ -233,7 +237,7 @@
233237

234238
特别感谢以下贡献者,他们的努力使这个项目变得更好:
235239

236-
- [Rick](https://linux.do/u/rick)
237-
- [Megasoft](https://linux.do/u/zhong_little)
240+
- [Rick](https://linux.do/u/rick)
241+
- [Megasoft](https://linux.do/u/zhong_little)
238242
- [fangyuan99](https://linux.do/u/fangyuan99)
239-
- [juzeon](https://github.com/juzeon)
243+
- [juzeon](https://github.com/juzeon)

0 commit comments

Comments
 (0)