Hugo-Jiang commited on
Commit
8f1571b
·
1 Parent(s): 954be92

update README.md file

Browse files
Files changed (1) hide show
  1. README.md +74 -1
README.md CHANGED
@@ -56,7 +56,9 @@ exchangeRates/
56
 
57
  ## 🚀 快速开始
58
 
59
- ### 1. 克隆项目
 
 
60
 
61
  ```bash
62
  cd C:\Users\Eleven\Desktop\exchangeRates
@@ -108,6 +110,64 @@ uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
108
  - 📚 **API 文档**: http://localhost:8000/docs
109
  - 📖 **ReDoc**: http://localhost:8000/redoc
110
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
111
  ## 📡 API 接口
112
 
113
  ### 获取所有汇率
@@ -206,6 +266,19 @@ POST /api/refresh
206
  | MAX_RETRIES | 最大重试次数 | 3 |
207
  | SERVER_PORT | 服务端口 | 8000 |
208
 
 
 
 
 
 
 
 
 
 
 
 
 
 
209
  ## 🔑 API Key 获取
210
 
211
  1. 访问 [ExchangeRate-API](https://www.exchangerate-api.com/)
 
56
 
57
  ## 🚀 快速开始
58
 
59
+ ### 本地部署
60
+
61
+ #### 1. 克隆项目
62
 
63
  ```bash
64
  cd C:\Users\Eleven\Desktop\exchangeRates
 
110
  - 📚 **API 文档**: http://localhost:8000/docs
111
  - 📖 **ReDoc**: http://localhost:8000/redoc
112
 
113
+ ### Hugging Face Spaces 部署
114
+
115
+ 本项目支持一键部署到 Hugging Face Spaces。
116
+
117
+ #### 1. 创建 README.md 头部配置
118
+
119
+ 在项目根目录的 README.md 文件顶部添加以下 YAML 配置:
120
+
121
+ ```yaml
122
+ ---
123
+ title: Exchange Rates Service
124
+ emoji: 💱
125
+ colorFrom: blue
126
+ colorTo: green
127
+ sdk: docker
128
+ pinned: false
129
+ license: mit
130
+ ---
131
+ ```
132
+
133
+ #### 2. 创建 Dockerfile
134
+
135
+ 项目需要包含 Dockerfile 用于 Spaces 部署:
136
+
137
+ ```dockerfile
138
+ FROM python:3.9-slim
139
+
140
+ WORKDIR /app
141
+
142
+ COPY requirements.txt .
143
+ RUN pip install --no-cache-dir -r requirements.txt
144
+
145
+ COPY . .
146
+
147
+ EXPOSE 7860
148
+
149
+ CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "7860"]
150
+ ```
151
+
152
+ #### 3. 配置环境变量
153
+
154
+ 在 Hugging Face Spaces 设置中添加 Secrets:
155
+ - `API_KEYS`: 你的 ExchangeRate-API Keys(逗号分隔)
156
+ - `BASE_CURRENCY`: 基准货币(默认 CNY)
157
+ - `CACHE_UPDATE_INTERVAL`: 缓存更新间隔(默认 3600)
158
+
159
+ #### 4. 部署步骤
160
+
161
+ 1. 在 [Hugging Face](https://huggingface.co/) 创建新的 Space
162
+ 2. 选择 Docker SDK
163
+ 3. 上传项目文件或连接 Git 仓库
164
+ 4. 在 Settings 中配置 Secrets
165
+ 5. Space 将自动构建和部署
166
+
167
+ #### 5. 访问服务
168
+
169
+ 部署成功后,可通过 `https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME` 访问服务。
170
+
171
  ## 📡 API 接口
172
 
173
  ### 获取所有汇率
 
266
  | MAX_RETRIES | 最大重试次数 | 3 |
267
  | SERVER_PORT | 服务端口 | 8000 |
268
 
269
+ ### Hugging Face Spaces 配置参数
270
+
271
+ | 参数 | 说明 | 示例值 |
272
+ |------|------|--------|
273
+ | sdk | SDK 类型 | docker |
274
+ | app_port | 应用端口(Spaces 默认 7860) | 7860 |
275
+ | title | Space 标题 | Exchange Rates Service |
276
+ | emoji | Space 图标 | 💱 |
277
+ | colorFrom | 渐变起始色 | blue |
278
+ | colorTo | 渐变结束色 | green |
279
+ | pinned | 是否固定在个人主页 | false |
280
+ | license | 开源协议 | mit |
281
+
282
  ## 🔑 API Key 获取
283
 
284
  1. 访问 [ExchangeRate-API](https://www.exchangerate-api.com/)