Skip to content

Commit

Permalink
feat: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
Hao-yiwen committed Nov 29, 2024
1 parent 3451352 commit a0cd1a8
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 28 deletions.
12 changes: 3 additions & 9 deletions .github/workflows/dart.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,6 @@ jobs:

- name: Build AAR
run: |
flutter build aar --release
echo "检查 AAR 构建输出目录"
ls -la build/host/outputs/repo/
- name: Upload AAR
uses: actions/upload-artifact@v3
with:
name: flutter-aar
path: build/host/outputs/repo/
cd android
chmod +x gradlew
./gradlew assembleRelease
59 changes: 40 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,58 @@
# 仿网易云音乐项目
# 网易云音乐 Flutter 版

![Flutter](https://img.shields.io/badge/flutter-v3.24.1-blue)
![iOS](https://img.shields.io/badge/iOS-12.0+-lightgrey)
![Android](https://img.shields.io/badge/Android-6.0+-brightgreen)

## 项目运行

此项目已经基本稳定,欢迎大家提出宝贵意见,帮助我们做得更好。

1. 启动后端服务,端口默认3000
- git clone https://gitlab.com/Binaryify/neteasecloudmusicapi.git
- npm i
- node app.js
2. 启动该项目,目前只支持短信验证码登录
## 项目简介

## 展示
这是一个使用 Flutter 开发的网易云音乐第三方客户端,致力于还原官方 App 的用户体验。

<img src="showcase/show_home.png" width="30%" style="display:inline-block;" />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="showcase/show_player.png" width="30%" style="display:inline-block;" />
### 技术特点

- 基于网易云音乐 9.1.55 版本进行开发
- Flutter SDK 版本: 3.24.1
- 后端接口采用开源项目:[NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi)
- 核心技术栈:
- 状态管理:GetX
- 依赖注入:GetIt
- 路由管理:GoRouter/AutoRouter

## 项目介绍
### 参考项目

flutter版本网易云音乐
- [bujuan](https://github.com/2697a/bujuan) - AutoRoute 实现参考
- [flutter_cloud_music](https://gitee.com/master_xing/flutter_cloud_music) - 底部播放控制栏实现

- 仿照网易云音乐版本 9.1.55
## 快速开始

- flutter开发版本: 3.24.1
项目当前已趋于稳定,我们非常欢迎社区的反馈和建议。

- 后端接口:https://github.com/Binaryify/NeteaseCloudMusicApi
### 环境配置

- 参考项目:
- https://github.com/2697a/bujuan autoroute
- https://gitee.com/master_xing/flutter_cloud_music 底部粘性播放条实现
1. 启动后端服务(默认端口 3000)
```bash
git clone https://gitlab.com/Binaryify/neteasecloudmusicapi.git
npm install
node app.js
```

- 技术栈:getx, getit, gorouter/autoRouter
2. 运行 Flutter 项目
```bash
flutter run -d <your-device>
```

3. 使用手机号码和短信验证码登录即可开始体验

## 已知问题

- 服务器部署的接口目前存在登录稳定性问题,可能出现401登录环境异常的情况。建议在本地启动服务以获得最佳体验。
- 为了优化主页展示效果,部分数据需要调用多个后端接口进行整合,可能导致加载速度较慢。我们正在对此进行优化,以提升用户体验。

## App预览

<img src="showcase/show_gif.gif" width="30%" style="display:inline-block;" />

## 页面预览

Expand Down
15 changes: 15 additions & 0 deletions ios/Runner.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -482,8 +482,13 @@
MARKETING_VERSION = 1.0;
PRODUCT_BUNDLE_IDENTIFIER = com.example.neteaseCloudMusicApp;
PRODUCT_NAME = "$(TARGET_NAME)";
SUPPORTED_PLATFORMS = "iphoneos iphonesimulator";
SUPPORTS_MACCATALYST = NO;
SUPPORTS_MAC_DESIGNED_FOR_IPHONE_IPAD = NO;
SUPPORTS_XR_DESIGNED_FOR_IPHONE_IPAD = NO;
SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
SWIFT_VERSION = 5.0;
TARGETED_DEVICE_FAMILY = 1;
VERSIONING_SYSTEM = "apple-generic";
};
name = Profile;
Expand Down Expand Up @@ -668,9 +673,14 @@
MARKETING_VERSION = 1.0;
PRODUCT_BUNDLE_IDENTIFIER = com.example.neteaseCloudMusicApp;
PRODUCT_NAME = "$(TARGET_NAME)";
SUPPORTED_PLATFORMS = "iphoneos iphonesimulator";
SUPPORTS_MACCATALYST = NO;
SUPPORTS_MAC_DESIGNED_FOR_IPHONE_IPAD = NO;
SUPPORTS_XR_DESIGNED_FOR_IPHONE_IPAD = NO;
SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
SWIFT_OPTIMIZATION_LEVEL = "-Onone";
SWIFT_VERSION = 5.0;
TARGETED_DEVICE_FAMILY = 1;
VERSIONING_SYSTEM = "apple-generic";
};
name = Debug;
Expand All @@ -694,8 +704,13 @@
MARKETING_VERSION = 1.0;
PRODUCT_BUNDLE_IDENTIFIER = com.example.neteaseCloudMusicApp;
PRODUCT_NAME = "$(TARGET_NAME)";
SUPPORTED_PLATFORMS = "iphoneos iphonesimulator";
SUPPORTS_MACCATALYST = NO;
SUPPORTS_MAC_DESIGNED_FOR_IPHONE_IPAD = NO;
SUPPORTS_XR_DESIGNED_FOR_IPHONE_IPAD = NO;
SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
SWIFT_VERSION = 5.0;
TARGETED_DEVICE_FAMILY = 1;
VERSIONING_SYSTEM = "apple-generic";
};
name = Release;
Expand Down
Binary file added showcase/show_gif.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a0cd1a8

Please sign in to comment.