# QXMusic

**Repository Path**: FaithALL/QXMusic

## Basic Information

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

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-06-21
- **Last Updated**: 2022-04-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# QXMusic

_启翔云音乐 v2.0，带来全新的音乐体验_

## 目录

* [介绍](#介绍)
* [软件架构](#软件架构)
* [安装教程](#安装教程)
* [项目组织说明](#项目组织说明)

### 介绍

启翔云音乐是一个全平台的音乐项目，具有windows、macos、linux平台安装包，也可部署在服务器，并提供web管理端进行管理。

### 软件架构

项目采取B/S架构，服务端采用springboot开发框架，前端采用vue开发，两者采用HTTP协议进行交互。前端采用webpack作为构建工具，以node开启一个electron进程加载前端页面，从而作为客户端。

### 安装教程

```shell
#dev代表开发版本，会在本地开一个服务器(不是服务端)便于查看网页
#build代表编译版本，会生成html、js、css等文件，用于部署
#client包括以下四个命令，每个命令包含release(默认)、dev、test三个选项
npm run devWeb
npm run buildWeb
npm run devApp
npm run buildApp
#manager包括以下四个命令
npm run dev
npm run build
```

### 项目组织说明

* server：服务端，spring boot，docker部署
* client：客户端及Web端开发目录
  * builder：客户端及Web端构建目录，包含对应的构建脚本和webpack配置文件
  * config：项目配置信息(端口、主机、版本信息)
  * src：源代码
    * main：主进程代码(electron入口、窗口创建、快捷键等)
    * render：渲染进程代码(也是Web端代码)，是项目主页面
    * public：网页favicon、客户端logo等
  * package.json：npm库管理识别文件
* manager：Web管理端开发目录
  * build：构建目录，包含对应构架脚本和webpack配置文件
  * config：服务端端口、主机等信息
  * src：vue项目开发目录，包含路由、通信等
  * static：项目静态资源