update readme

DEPLOYMENT.md

@@ -1,107 +0,0 @@
-# PaperIndex Deployment Guide
-
-## Hugging Face Spaces Deployment
-
-### 1. Create Space
-
-1. Visit [Hugging Face Spaces](https://huggingface.co/spaces)
-2. Click "Create new Space"
-3. Select "Docker" as SDK
-4. Set Space name (e.g., "paperindex")
-5. Choose "Public" or "Private"
-
-### 2. Secure API Key Configuration
-
-**Important: Never hardcode API keys in your code!**
-
-#### Method 1: Use HF Spaces Secrets (Recommended)
-
-1. On your Space page, click the "Settings" tab
-2. Find "Repository secrets" in the left menu
-3. Click "New secret"
-4. Add the following secret:
-   - **Name**: `ANTHROPIC_API_KEY`
-   - **Value**: Your Anthropic API key
-
-#### Method 2: Use Environment Variables (Local Development Only)
-
-Create a `.env` file (do not commit to Git):
-```bash
-ANTHROPIC_API_KEY=your_api_key_here
-```
-
-### 3. Push Code
-
-```bash
-# Ensure database files use Git LFS
-git lfs track "*.db"
-git add .gitattributes
-
-# Commit and push
-git add .
-git commit -m "Update deployment configuration"
-git push origin main
-```
-
-### 4. Verify Deployment
-
-1. Wait for HF Spaces to auto-build (usually 2-5 minutes)
-2. Visit your Space URL: `https://huggingface.co/spaces/your-username/paperindex`
-3. Check if the application is running properly
-
-## Local Docker Deployment
-
-### 1. Build Image
-
-```bash
-docker build -t paperindex .
-```
-
-### 2. Run Container
-
-```bash
-# Using environment variables
-docker run -d -p 7860:7860 \
-  -e ANTHROPIC_API_KEY=your_api_key_here \
-  --name paperindex-app paperindex
-
-# Or using .env file
-docker run -d -p 7860:7860 \
-  --env-file .env \
-  --name paperindex-app paperindex
-```
-
-### 3. Access Application
-
-Open browser and visit: `http://localhost:7860`
-
-## Security Considerations
-
-1. **Never** hardcode API keys in your code
-2. **Never** commit `.env` files to Git repository
-3. Use HF Spaces Secrets to store sensitive information
-4. Regularly rotate API keys
-5. Monitor API usage
-
-## Troubleshooting
-
-### Common Issues
-
-1. **API Key Error**
-   - Check if HF Spaces Secrets are set correctly
-   - Verify API key is valid
-
-2. **Build Failure**
-   - Check Dockerfile syntax
-   - View build logs
-
-3. **Application Won't Start**
-   - Check port configuration
-   - View container logs: `docker logs paperindex-app`
-
-### Getting Help
-
-If you encounter issues:
-1. Check HF Spaces build logs
-2. View application logs
-3. Report issues in GitHub Issues

README.md

@@ -1,3 +1,14 @@
+---
+title: PaperIndex
+emoji: 📚
+colorFrom: blue
+colorTo: purple
+sdk: docker
+sdk_version: "latest"
+app_file: app.py
+pinned: false
+---
+
 # PaperIndex
 
 A beautiful web application for browsing and evaluating daily papers from Hugging Face, featuring a modern UI inspired by Hugging Face's design.
@@ -12,7 +23,7 @@ A beautiful web application for browsing and evaluating daily papers from Huggin
 
 ## Live Demo
 
-🌐 **Hugging Face Spaces**: [PaperIndex Demo](https://huggingface.co/spaces/your-username/paperindex)
+🌐 **Hugging Face Spaces**: [PaperIndex Demo](https://huggingface.co/spaces/zwt963/paperindex)
 
 ## Local Development
 
@@ -45,59 +56,116 @@ python -m uvicorn server:app --reload --host 0.0.0.0 --port 8000
 
 ### Hugging Face Spaces (Recommended) - FREE!
 
-**Hugging Face Spaces 完全免费，包含：**
-- ✅ 无限个人项目
-- ✅ 自动 HTTPS
-- ✅ 全球 CDN
-- ✅ 自动部署
-- ✅ 自定义域名支持
+**Hugging Face Spaces is completely free and includes:**
+- ✅ Unlimited personal projects
+- ✅ Automatic HTTPS
+- ✅ Global CDN
+- ✅ Automatic deployment
+- ✅ Custom domain support
 
-#### 部署步骤：
+#### Deployment Steps:
 
-1. **创建 Space**：
-   - 访问 [Hugging Face Spaces](https://huggingface.co/spaces)
-   - 点击 "Create new Space"
-   - 选择 "Gradio" 作为 SDK
-   - 设置 Space 名称（如 "paperindex"）
-   - 选择 "Public" 或 "Private"
+1. **Create Space**:
+   - Visit [Hugging Face Spaces](https://huggingface.co/spaces)
+   - Click "Create new Space"
+   - Select "Docker" as SDK
+   - Set Space name (e.g., "paperindex")
+   - Choose "Public" or "Private"
 
-2. **配置访问令牌**：
-   ```bash
-   # 复制环境变量模板
-   cp env.example .env
+2. **Secure API Key Configuration**:
+   
+   **Important: Never hardcode API keys in your code!**
    
-   # 编辑 .env 文件，添加你的 Hugging Face 访问令牌
-   # 获取令牌：https://huggingface.co/settings/tokens
-   # 确保选择 "Write" 权限
+   **Method 1: Use HF Spaces Secrets (Recommended)**
+   - On your Space page, click the "Settings" tab
+   - Find "Repository secrets" in the left menu
+   - Click "New secret"
+   - Add the following secret:
+     - **Name**: `ANTHROPIC_API_KEY`
+     - **Value**: Your Anthropic API key
+   
+   **Method 2: Use Environment Variables (Local Development Only)**
+   Create a `.env` file (do not commit to Git):
+   ```bash
+   ANTHROPIC_API_KEY=your_api_key_here
    ```
 
-3. **一键部署**：
+3. **Push Code**:
    ```bash
-   # 使用部署脚本
-   ./deploy_to_hf.sh your-username paperindex
+   # Ensure database files use Git LFS
+   git lfs track "*.db"
+   git add .gitattributes
+   
+   # Commit and push
+   git add .
+   git commit -m "Update deployment configuration"
+   git push origin main
    ```
 
-4. **自动部署**：
-   - Spaces 会自动检测 `app.py` 作为入口点
-   - 自动安装 `requirements.txt` 中的依赖
-   - 自动启动服务
+4. **Verify Deployment**:
+   - Wait for HF Spaces to auto-build (usually 2-5 minutes)
+   - Visit your Space URL: `https://huggingface.co/spaces/your-username/paperindex`
+   - Check if the application is running properly
 
-5. **访问你的应用**：
-   - 你的应用将在以下地址可用：`https://huggingface.co/spaces/your-username/paperindex`
-   - 部署完成后，你可以分享这个链接给任何人
+### Local Docker Deployment
 
-#### 重要文件说明：
+1. **Build Image**:
+   ```bash
+   docker build -t paperindex .
+   ```
 
-- `app.py` - Spaces 的入口点文件
-- `requirements.txt` - Python 依赖
-- `server.py` - 主要的 FastAPI 应用
-- `frontend/` - 静态前端文件
+2. **Run Container**:
+   ```bash
+   # Using environment variables
+   docker run -d -p 7860:7860 \
+     -e ANTHROPIC_API_KEY=your_api_key_here \
+     --name paperindex-app paperindex
+   
+   # Or using .env file
+   docker run -d -p 7860:7860 \
+     --env-file .env \
+     --name paperindex-app paperindex
+   ```
+
+3. **Access Application**:
+   Open browser and visit: `http://localhost:7860`
 
 ### Alternative Deployment Options
 
-- **Vercel**: 免费计划，无限个人项目
-- **Railway**: 简单部署，$5/月免费额度
-- **Render**: 免费层级可用
+- **Vercel**: Free plan, unlimited personal projects
+- **Railway**: Simple deployment, $5/month free tier
+- **Render**: Free tier available
+
+## Security Considerations
+
+1. **Never** hardcode API keys in your code
+2. **Never** commit `.env` files to Git repository
+3. Use HF Spaces Secrets to store sensitive information
+4. Regularly rotate API keys
+5. Monitor API usage
+
+## Troubleshooting
+
+### Common Issues
+
+1. **API Key Error**
+   - Check if HF Spaces Secrets are set correctly
+   - Verify API key is valid
+
+2. **Build Failure**
+   - Check Dockerfile syntax
+   - View build logs
+
+3. **Application Won't Start**
+   - Check port configuration
+   - View container logs: `docker logs paperindex-app`
+
+### Getting Help
+
+If you encounter issues:
+1. Check HF Spaces build logs
+2. View application logs
+3. Report issues in GitHub Issues
 
 ## Project Structure