Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uriopass/musidex
Your AI powered musical pokedex, Plex for music
https://github.com/uriopass/musidex
mediaserver mp3 music react react-native rust typescript
Last synced: 5 days ago
JSON representation
Your AI powered musical pokedex, Plex for music
- Host: GitHub
- URL: https://github.com/uriopass/musidex
- Owner: Uriopass
- License: gpl-3.0
- Created: 2021-07-28T13:47:55.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T10:45:16.000Z (7 months ago)
- Last Synced: 2024-04-24T05:12:00.268Z (7 months ago)
- Topics: mediaserver, mp3, music, react, react-native, rust, typescript
- Language: TypeScript
- Homepage:
- Size: 13.2 MB
- Stars: 53
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Musidex
Your musical pokedex, Plex for music.
Add songs from youtube videos or youtube playlist to your library,
or import them from your local files.
Tags are automatically imported and searchable,
sync it on your phone to enjoy free offline music, managed from your home server.
Don't want to bother making playlists?
Let Musidex handle it for you, a neural network analyses your musics and checks for similarity
to provide semantic autoplaying.
Choose a starting point and let it choose the next song for you!
### Demo
Try the demo at:
https://demo.douady.paris/
Please don't mess it up. :)
### Roadmap
- [x] Music streaming
- [x] Youtube import
- [x] Web front
- [x] Neural embedding based auto play
- [x] Text search
- [x] CI
- [x] Multiple accounts
- [x] Android App
- [x] Docker build
- [x] iOS App
- [x] Local download for apps
- [x] Browser extension to add YT videos to library directly from youtube
- [x] Tag filtering
- [ ] Playlists through tags/Tag editor
- [ ] Basic authentication
- [ ] CD
- [ ] MP3 import
- [ ] Ogg import
- [ ] FLAC import
# Setting up the server
### Using docker
```bash
# Build the image, can take up to 20 minutes depending on your CPU and your network bandwidth
docker build -t musidex .
# Run the container (replace /path/to/musidex with absolute path to Musidex, like $HOME/musidex)
docker run -d -p 80:3200 -v /path/to/musidex/storage:/storage -t musidex
```
All musidex data (musics, thumbnails, db) ends up in the `storage` directory.
### Linux
Only GNU/Linux distros are supported at the moment.
#### Dependencies
You can run the `prepare.sh` script after cloning to run all of the following commands,
or run them yourself with an explanation.
[Youtube-dl](https://github.com/yt-dlp/yt-dlp/wiki/Installation#with-pip) to add music from youtube URLs.
```bash
python3 -m pip install -U yt-dlp
```
Ffmpeg so that the downloaded audio files are converted to more friendly formats. (as advised by youtube-dl).
Npm for the frontend.
Sqlite for the db.
```bash
sudo apt install ffmpeg npm libsqlite3-dev python3 python-is-python3
```
The [rust compiler](https://www.rust-lang.org/tools/install) for the backend.
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
source "$HOME"/.cargo/env
```
The repo itself.
```bash
git clone https://github.com/Uriopass/Musidex
cd Musidex
# Prepare the web dependencies
(cd musidex-web && npm install)
```
#### Building and running
```bash
# Just run the start script
./start.sh
```
# Developing on the project
First install the dependencies as listed above, then
```bash
# Start the daemon, will listen on localhost:3200
cargo run --manifest-path=musidex-daemon/Cargo.toml
# And in another terminal... start the web client
cd musidex-web
npm start # will start on localhost:3000
# and proxy api requests to the daemon
```
Then if you want to work on the daemon,
simply run `cargo run` again after doing your modifications.
If you want to work on the web client,
the modifications will be hot reloaded.
All musidex data ends up in the `storage` directory.