# github-project-viewer

**Repository Path**: hao-shaopeng58/github-project-viewer

## Basic Information

- **Project Name**: github-project-viewer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-05
- **Last Updated**: 2026-03-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GitHub 项目速览

一个快速搜索、查看和预览 GitHub 开源项目的网站。

## 功能特点

- **🔍 项目搜索** - 通过关键词搜索 GitHub 项目
- **👤 用户项目** - 查看指定用户的所有仓库
- **🔥 趋势项目** - 显示最近热门的开源项目
- **⭐ 收藏功能** - 收藏感兴趣的项目（本地存储）
- **📄 README 预览** - 渲染 Markdown 格式的 README
- **📁 文件浏览** - 浏览项目文件结构和代码
- **🚀 快速链接** - 一键访问 GitHub、GitHub Pages 等

## 技术栈

- Next.js 14 + TypeScript
- Tailwind CSS
- shadcn/ui
- GitHub API

## 本地开发

```bash
cd my-app
npm install
npm run dev
```

访问 http://localhost:3000

## 部署

### 部署到 Vercel（推荐）

```bash
npm install -g vercel
vercel --prod
```

### 静态部署

构建好的静态文件在 `dist` 目录，可以直接上传到任何静态托管服务：
- Vercel
- Netlify
- GitHub Pages
- Cloudflare Pages

```bash
cd my-app
npm run build
# dist 目录即为部署文件
```

## GitHub API 限制

GitHub API 有请求限制：
- 未认证：每小时 60 次请求
- 已认证：每小时 5000 次请求

如需提高限制，可以添加 GitHub Token：
1. 访问 https://github.com/settings/tokens
2. 生成一个 token（不需要任何权限）
3. 在项目根目录创建 `.env.local` 文件：
   ```
   NEXT_PUBLIC_GITHUB_TOKEN=your_token_here
   ```

## 文件结构

```
my-app/
├── app/
│   ├── globals.css      # 全局样式
│   ├── layout.tsx       # 根布局
│   └── page.tsx         # 主页面
├── components/
│   ├── SearchBar.tsx    # 搜索栏组件
│   ├── RepoCard.tsx     # 项目卡片组件
│   ├── RepoDetail.tsx   # 项目详情组件
│   ├── FileTree.tsx     # 文件树组件
│   └── ReadmeViewer.tsx # README 查看器
├── lib/
│   ├── types.ts         # 类型定义
│   ├── github.ts        # GitHub API 封装
│   └── utils.ts         # 工具函数
└── components/ui/       # shadcn/ui 组件
```

## License

MIT