Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lideming/musiccloud
Web client of MusicCloud
https://github.com/lideming/musiccloud
lrc lyrics music music-player typescript webapp webfx
Last synced: 10 days ago
JSON representation
Web client of MusicCloud
- Host: GitHub
- URL: https://github.com/lideming/musiccloud
- Owner: lideming
- License: mit
- Created: 2019-11-14T07:18:03.000Z (almost 5 years ago)
- Default Branch: dev
- Last Pushed: 2024-08-28T17:17:33.000Z (2 months ago)
- Last Synced: 2024-10-12T02:47:44.478Z (25 days ago)
- Topics: lrc, lyrics, music, music-player, typescript, webapp, webfx
- Language: TypeScript
- Homepage: https://mc.yuuza.net
- Size: 1.36 MB
- Stars: 20
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MusicCloud
MusicCloud is a music website built with [webfx](https://github.com/lideming/webfx).
This repo contains the frontend parts of MusicCloud.
[The server](https://github.com/lideming/MusicCloudServer) is also open-sourced.
You can easily [run your own MusicCloud instance in Docker](https://github.com/lideming/MusicCloudServer#run-in-docker-).
[](https://github.com/lideming/MusicCloud/actions/workflows/main.yml)
## Features
- Music player
- Single-page application
- Upload and manage tracks
- Share tracks and playlists
- Search tracks
- Lyrics with translation and ruby annotations, extended from LRC.
- Comment and discussion
- Login with OpenID Connect
- More in [TODO](https://github.com/lideming/MusicCloud/projects/1)
## Configure Build
Modify `src/Settings/Settings.ts` for API location, debug options etc.
## Build
Though `npm` may still work, we use [pnpm](https://pnpm.io/) as the package manager.
Install `pnpm` if needed, see [pnpm docs](https://pnpm.io/installation) for more examples:
```
npx pnpm add -g pnpm
```
Install development dependencies:
```
pnpm install
```
Start the building process:
```
pnpm build
```
## Deploy
Copy `dist/*` to the static website folder (see `staticdir` in [server side configration](https://github.com/lideming/MusicCloudServer/blob/master/appsettings.json)).
## Reusable Components
- [webfx](https://github.com/lideming/webfx) - Web UI framework with utilities and basic views
- `src/Lyrics/Lyrics.ts` - Lyrics parser/serializer (LRC with optional MusicCloud extension)