📃 docs: 修改文档

This commit is contained in:
alger
2025-01-01 02:43:00 +08:00
parent edb7ea201c
commit eeda296589
7 changed files with 83 additions and 21 deletions
+82 -20
View File
@@ -1,34 +1,96 @@
# electron-lan-file # Alger Music Player
主要功能如下
An Electron application with Vue and TypeScript - 音乐推荐
- 网易云登录
- 播放历史
- 桌面歌词
- 歌单 mv 搜索 专辑等功能
- 识别无法播放歌曲 并解析播放
- 主题切换 更新检测
- 本地服务 不依赖线上服务
- 可听周杰伦(搜索专辑)
## Recommended IDE Setup ## 项目简介
一个基于 electron typescript vue3 的桌面音乐播放器 适配 web端 桌面端 web移动端
- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) ## 预览地址
[http://mc.alger.fun/](http://mc.alger.fun/)
## Project Setup QQ群:789288579
### Install ## 软件截图
![首页白](./docs/img/image.png)
![首页黑](./docs/img/image3.png)
![歌词](./docs/img/image1.png)
![桌面歌词](./docs/img/image2.png)
## 技术栈
### 主要框架
- Vue 3 - 渐进式 JavaScript 框架
- TypeScript - JavaScript 的超集,添加了类型系统
- Electron - 跨平台桌面应用开发框架
- Vite - 下一代前端构建工具
- Naive UI - 基于 Vue 3 的组件库
## 咖啡☕️
| 微信 | 支付宝 |
| :--------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------: |
| <img src="https://github.com/algerkong/algerkong/blob/main/wechat.jpg?raw=true" alt="WeChat QRcode" width=200> | <img src="https://github.com/algerkong/algerkong/blob/main/alipay.jpg?raw=true" alt="Wechat QRcode" width=200> |
## 项目运行
```bash
# 安装依赖
npm install
# 运行项目 web
npm run dev
# 运行项目 electron
npm run start
# 打包项目 web
npm run build
# 打包项目 electron
npm run win ...
# 具体看 package.json
```
#### 注意
- 本地运行需要配置 .env.development 文件
- 打包需要配置 .env.production 文件
```bash ```bash
$ npm install # .env.development
VITE_API_LOCAL = /api
VITE_API_MUSIC_PROXY = /music
VITE_API_PROXY_MUSIC = /music_proxy
# 你的接口地址 (必填)
VITE_API = ***
# 音乐po接口地址
VITE_API_MUSIC = ***
VITE_API_PROXY = ***
# .env.production
# 你的接口地址 (必填)
VITE_API = ***
# 音乐po接口地址
VITE_API_MUSIC = ***
# 代理地址
VITE_API_PROXY = ***
``` ```
### Development ## Stargazers over time
[![Stargazers over time](https://starchart.cc/algerkong/AlgerMusicPlayer.svg?variant=adaptive)](https://starchart.cc/algerkong/AlgerMusicPlayer)
```bash
$ npm run dev
```
### Build
```bash
# For windows
$ npm run build:win
# For macOS ## 欢迎提Issues
$ npm run build:mac
# For Linux ## 免责声明
$ npm run build:linux 本软件仅用于学习交流,禁止用于商业用途,否则后果自负。
```
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 3.1 MiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 MiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 MiB

-1
View File
@@ -51,7 +51,6 @@ function createWindow(): void {
mainWindow.webContents.openDevTools({ mode: 'detach' }); mainWindow.webContents.openDevTools({ mode: 'detach' });
mainWindow.loadURL(process.env.ELECTRON_RENDERER_URL); mainWindow.loadURL(process.env.ELECTRON_RENDERER_URL);
} else { } else {
mainWindow.webContents.openDevTools({ mode: 'detach' });
mainWindow.loadFile(join(__dirname, '../renderer/index.html')); mainWindow.loadFile(join(__dirname, '../renderer/index.html'));
} }
+1
View File
@@ -49,6 +49,7 @@
</div> </div>
</div> </div>
</div> </div>
<div class="pb-20"></div>
<play-bottom /> <play-bottom />
</n-scrollbar> </n-scrollbar>
</div> </div>