From 0e6c40f32f14796bfcfb18a8d24a87dedfa4d200 Mon Sep 17 00:00:00 2001 From: wenjie Date: Tue, 16 Mar 2021 12:25:02 +0800 Subject: [PATCH] docs: add dev readme, format readme with prettier (#422) * docs: add dev readme, format file * Update README.md --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 44 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0ac67e6..6d7f7f3 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,8 @@ Electron 版本由 [@hawtim](https://github.com/hawtim) 和 [@qier222](https://github.com/qier222) 适配并维护，支持 macOS、Windows、Linux。 -访问本项目的 [Releases](https://github.com/qier222/YesPlayMusic/releases) 页面下载安装包，或者访问 [镜像下载站 (大陆访问更快)](https://dl.qier222.com/YesPlayMusic/) 下载。 +访问本项目的 [Releases](https://github.com/qier222/YesPlayMusic/releases) +页面下载安装包，或者访问 [镜像下载站 (大陆访问更快)](https://dl.qier222.com/YesPlayMusic/) 下载。 macOS 用户也可以通过 `brew install --cask yesplaymusic` 来安装。 @@ -47,7 +48,8 @@ macOS 用户也可以通过 `brew install --cask yesplaymusic` 来安装。 除了下载安装包使用，你还可以将本项目部署到 Vercel 或你的服务器上。下面是部署到 Vercel 的方法 -1. 部署网易云 API，详情参见 [Binaryify/NeteaseCloudMusicApi](https://neteasecloudmusicapi.vercel.app/#/?id=%e5%ae%89%e8%a3%85) 。你也可以将 API 部署到 Vercel。 +1. 部署网易云 API，详情参见 [Binaryify/NeteaseCloudMusicApi](https://neteasecloudmusicapi.vercel.app/#/?id=%e5%ae%89%e8%a3%85) + 。你也可以将 API 部署到 Vercel。 2. 点击本仓库右上角的 Fork，复制本仓库到你的 GitHub 账号。 @@ -57,13 +59,15 @@ macOS 用户也可以通过 `brew install --cask yesplaymusic` 来安装。 5. 点击 PERSONAL ACCOUNT 旁边的 Select。 -6. 点击 Environment Variables，填写 Name 为 `VUE_APP_NETEASE_API_URL`，Value 为你刚刚部署的网易云 API 地址，点击 Add。最后点击底部的 Deploy 就可以部署到 Vercel 了。 +6. 点击 Environment Variables，填写 Name 为 `VUE_APP_NETEASE_API_URL`，Value 为你刚刚部署的网易云 API 地址，点击 Add。最后点击底部的 Deploy 就可以部署到 + Vercel 了。 ## 👷‍♂️ 打包客户端 如果在 Release 页面没有找到适合你的设备的安装包的话，你可以根据下面的步骤来打包自己的客户端。 -1. 打包 Electron 需要用到 Node.js 和 Yarn。可前往 [Node.js 官网](https://nodejs.org/zh-cn/) 下载安装包。安装 Node.js 后可在终端里执行 `npm install -g yarn` 来安装 Yarn。 +1. 打包 Electron 需要用到 Node.js 和 Yarn。可前往 [Node.js 官网](https://nodejs.org/zh-cn/) 下载安装包。安装 Node.js + 后可在终端里执行 `npm install -g yarn` 来安装 Yarn。 2. 使用 `git clone https://github.com/qier222/YesPlayMusic.git` 克隆本仓库到本地。 @@ -80,6 +84,36 @@ macOS 用户也可以通过 `brew install --cask yesplaymusic` 来安装。 | `yarn electron:build --linux deb:armv7l` | Debian armv7l（树莓派等） | | `yarn electron:build --macos dir:arm64` | macOS ARM | +## :computer: 配置开发环境 + +本项目由 [NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi) 提供 API，已经包含在本项目的`netease_api`目录。 + +运行本项目 + +```shell +# 安装依赖 +yarn + +# 创建本地环境变量 +cp .env.example .env + +# 运行（网页端） +yarn serve + +# 运行（electron） +yarn electron:serve +``` + +本地运行 NeteaseCloudMusicApi，或者将 API [部署至 Vercel](#%EF%B8%8F-部署至-vercel) + +```shell +# 安装依赖 +cd netease_api && yarn + +# 运行 API （默认 3000 端口） +yarn start +``` + ## ☑️ Todo 查看 Todo 请访问本项目的 [Projects](https://github.com/qier222/YesPlayMusic/projects/1) @@ -114,9 +148,15 @@ API 源代码来自 [Binaryify/NeteaseCloudMusicApi](https://github.com/Binaryif [album-screenshot]: images/album.png + [artist-screenshot]: images/artist.png + [explore-screenshot]: images/explore.png + [home-screenshot]: images/home.png + [library-screenshot]: images/library.png + [playlist-screenshot]: images/playlist.png + [search-screenshot]: images/search.png