Skip to content

Commit

Permalink
feat: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
baiwumm committed May 7, 2024
1 parent 9661b47 commit 86abc8d
Showing 1 changed file with 27 additions and 13 deletions.
40 changes: 27 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,20 @@
<p>汇聚全网热点,热门尽览无余</p>
</div>

## 项目信息
## 🚩 项目信息
* 项目预览:https://hot.baiwumm.com/
* 技术栈:[React](https://react.dev/)[Vite](https://www.vitejs.net/)[Ant-design](https://ant-design.antgroup.com/)

## 演示图
## 💻 演示图

<div style="display:flex;justify-content:space-between;">
<img alt="亮色模式" src="./src/assets/light.png" style="width:49%;"/>
<img alt="暗色模式" src="./src/assets/dark.png" style="width:49%;"/>
</div>

## 热点平台
## 💯 热点平台

✅:稳定,⭕:不稳定,❌:无法使用

| **Logo** | **平台** | **类别** | **接口地址** | **状态** |
| :--------: | :--------: | :--------: | :--------: |:--------: |
Expand All @@ -35,10 +37,11 @@
|<img alt="历史上的今天" src="./public/today.svg" width="30" style="display:inline-block"/>| 百度百科 | 历史上的今天 | [today](https://api.baiwumm.com/hot/today) ||
|<img alt="微信读书" src="./public/weread.svg" width="30" style="display:inline-block"/>| 微信读书 | 飙升榜 | [weread](https://api.baiwumm.com/hot/weread) ||
|<img alt="豆瓣电影" src="./public/douban-movic.svg" width="30" style="display:inline-block"/>| 豆瓣电影 | 新片榜 | [douban-movic](https://api.baiwumm.com/hot/douban-movic) ||
|<img alt="网易云音乐" src="./public/netease-music.svg" width="30" style="display:inline-block"/>| 网易云音乐 | 热歌榜 | [netease-music](https://api.baiwumm.com/hot/netease-music) ||

> 以上 API 是基于 [Nest.js](https://nest.nodejs.cn/) 搭建的
> 以上 `API` 基于 [Nest.js](https://nest.nodejs.cn/) 搭建。
## 项目运行
## 项目运行
```
// 克隆项目
git clone https://github.com/baiwumm/react-daily-hot.git
Expand All @@ -50,17 +53,16 @@ pnpm install
pnpm dev
```

## Vercel 私有部署
1. `Fork` 本项目
2.`Vercel` 官网点击 `New Project`
3. 点击 `Import Git Repository` 并选择你 fork 的此项目并点击 `import`
4. `PROJECT NAME`自己填,`FRAMEWORK PRESET``Other` 然后直接点 `Deploy` 接着等部署完成即可
## ⚙️ Vercel 一键部署
1. `Fork` 本项目,在 `Vercel` 官网点击 `New Project`
2. 点击 `Import Git Repository` 并选择你 fork 的此项目并点击 `import`
3. `PROJECT NAME`自己填,`FRAMEWORK PRESET``Other` 然后直接点 `Deploy` 接着等部署完成即可

<a href="https://vercel.com/dashboard" target="_blank">
<img alt="vercel 部署" src="./src/assets/vercel.svg" />
</a>

## Vecel 本地部署
## ⚙️ Vecel 本地部署
```
// 全局安装 vercel
npm i -g vercel
Expand All @@ -76,5 +78,17 @@ vercel --prod
```
> 具体教程可参考文章:[如何使用 Vercel 托管静态网站](https://baiwumm.com/p/5zzij7bt)
## 其他
> 如果想集成其他平台的热搜或热点 API,可以提 Issues
## ⚠️ 须知
1. 本项目的接口会频繁请求官方数据,部分接口使用了 **页面爬虫抓取**,若违反对应页面的相关规则,请 **及时通知我去除该接口**
2. 如果想集成其他平台的热搜或热点 `API`,可以提 `Issues`
3. 本项目提供的 `API` 仅供开发者进行技术研究和开发测试使用,任何因使用本 `API` 产生的损失,本项目不负担任何赔偿和责任

## 😘 鸣谢
特此感谢为本项目提供支持与灵感的项目,本项目在其基础上使用 `React``Nest` 构建并优化,感谢开源社区提供的精神支持

- [imsyy/DailyHot](https://github.com/imsyy/DailyHot)
- [imsyy/DailyHotApi](https://github.com/imsyy/DailyHotApi)

## ⭐ Star History

[![Star History Chart](https://api.star-history.com/svg?repos=baiwumm/react-daily-hot&type=Date)](https://star-history.com/#baiwumm/react-daily-hot&Date)

0 comments on commit 86abc8d

Please sign in to comment.