neteast-cloud-music-player/README.md

109 lines
2.9 KiB
Markdown
Raw Normal View History

2020-02-28 10:21:05 +00:00
# neteast-music-vue
2020-03-10 09:35:46 +00:00
2020-03-10 10:20:15 +00:00
### Deployed link:
2020-03-10 09:35:46 +00:00
https://neteast.netlify.com/
2020-03-09 03:50:40 +00:00
### It is a mobile first responsive web app for listening music from Neteast cloud platform which is using a open source API:
2020-03-09 03:48:51 +00:00
https://github.com/Binaryify/NeteaseCloudMusicApi
2020-02-28 10:21:05 +00:00
2020-03-09 03:50:40 +00:00
### The stack is based on Vue, VueX, VueRouter, Vuetify, Axios, PWA, SCSS, Jest, Nightwatch, Eslint, Babel and others.
2020-03-09 03:46:15 +00:00
![picture 01](https://github.com/tatoMa/neteast-cloud-music-player/blob/master/01.jpg?raw=true)
2020-03-09 03:48:51 +00:00
2020-03-09 03:46:15 +00:00
![picture 02](https://github.com/tatoMa/neteast-cloud-music-player/blob/master/02.jpg?raw=true)
2020-04-15 08:31:36 +00:00
![picture 03](https://github.com/tatoMa/neteast-cloud-music-player/blob/master/03.png?raw=true)
2020-03-20 11:18:43 +00:00
Backend
- [x] compressed api by g-zip
- [x] proxy settings
Frontend
2020-04-07 09:37:18 +00:00
- [ ] maybe net-east account?
2020-03-11 07:57:29 +00:00
- [ ] maybe login?
2020-03-17 10:31:05 +00:00
- [ ] add full PWA support?
2020-03-19 09:02:03 +00:00
- [ ] Progressive Loading? different layout or resources based on device types and network speed
2020-03-11 07:57:29 +00:00
- [ ] download music function
2020-03-17 10:31:05 +00:00
- [ ] redo player animation and transaction
- [ ] UX/UI logic refactor
2020-03-19 09:02:03 +00:00
- [ ] add Skeleton loaders
2020-03-20 11:18:43 +00:00
- [ ] Lyric sync
2020-04-07 09:37:18 +00:00
- [ ] player loop/random function
- [ ] Home page desktop view add playlist, player, and lyric page
2020-04-15 08:31:36 +00:00
- [x] Home page restructure for desktop view
2020-03-29 09:42:18 +00:00
- [x] theme and color settings
- [x] setting page
- [x] album page
- [x] artist page
- [x] large image adaptive loading
- [x] music progress slider click and jump to time function
2020-03-20 11:18:43 +00:00
- [x] Lyric display
2020-03-15 23:45:48 +00:00
- [x] fix Chrome security policy don't allow instantiate AudioContext before load audio source
2020-03-14 04:07:22 +00:00
- [x] fix music url request 403 error (by adding referrer head into index page)
2020-03-14 01:16:23 +00:00
- [x] reduce the bundle size and loading size(to homepage 440k total)
2020-03-13 09:06:58 +00:00
- [x] material icon tree-shaking (Reduce 300K after build the bundle)
2020-03-11 10:09:51 +00:00
- [x] message tab with styled component and function
- [x] click and play music without wipeout playlist
2020-03-11 07:57:29 +00:00
- [x] audio analyser and synchronizer effect by web api and drawing on canvas
- [x] playlist tab in player
- [x] player tabs and sections
2020-03-11 07:59:39 +00:00
- [x] music wave effect (removed)
2020-03-11 07:57:29 +00:00
- [x] player buttons
- [x] slider for volume control
- [x] slider for audio progress
- [x] full screen player mode
- [x] animated transition
- [x] hot music page Tabs and sections
- [x] theme switch (dark and light)
- [x] pagination for all list
- [x] add to playlist function
- [x] play all music in list function
- [x] responsive design implement
- [x] search
- [x] navigation drawer
- [x] hot music page
- [x] player controller
- [x] state management init
- [x] utils and apis
- [x] hot playlists page
2020-03-14 09:32:28 +00:00
### need a env file to start this app
```
.env
VUE_APP_baseURL=Your URL
```
2020-03-09 03:46:15 +00:00
#### Project setup
2020-02-28 10:21:05 +00:00
```
npm install
```
2020-03-09 03:46:15 +00:00
##### Compiles and hot-reloads for development
2020-02-28 10:21:05 +00:00
```
npm run serve
```
2020-03-09 03:46:15 +00:00
##### Compiles and minifies for production
2020-02-28 10:21:05 +00:00
```
npm run build
```
2020-03-09 03:46:15 +00:00
##### Run your unit tests
2020-02-28 10:21:05 +00:00
```
npm run test:unit
```
2020-03-09 03:46:15 +00:00
##### Run your end-to-end tests
2020-02-28 10:21:05 +00:00
```
npm run test:e2e
```
2020-03-09 03:46:15 +00:00
##### Lints and fixes files
2020-02-28 10:21:05 +00:00
```
npm run lint
```
2020-03-09 03:46:15 +00:00
##### Customize configuration
2020-02-28 10:21:05 +00:00
See [Configuration Reference](https://cli.vuejs.org/config/).