mirror of
https://github.com/cstaelen/shazarr.git
synced 2026-10-19 01:31:11 -05:00
ae195c23f36aebbf7802e027bf5b92daae5b0c95
Shazarr - ShazamIO web UI
This project provides a mobile app to shazam songs with Lidarr and Tidarr integration.
Features
- 5 sec audio capture and song recognition using python ShazamIO.
- Download queried album to Lidarr
- Download queried song/album with Tidarr
- Listen on streaming app like Spotify
- Show lyrics
- Record and recognize later if API is not accessible
- Record ghistory
Get started
In order to use it you will have to install :
- Docker image to query Shazam services
- Android mobile app APK
Proceed:
- Pull and up docker image
cstaelen/shazarr-api - Go to url on
http://<docker-host>:12358 - Download APK by scanning qrcode
- Fill Shazarr API URL in app
1. Docker image
Using docker-compose.yml:
version: "3"
services:
shazarr-api:
image: cstaelen/shazarr-api:latest
ports:
- 12358:12358
environment:
- LIDARR_API_KEY=123456789abcdef
- LIDARR_URL=http://<lidarr-web-ui-url>
- LIDARR_LIBRARY_PATH=/music/
- TIDARR_URL=http://<tidarr-web-ui-url>
Using docker run:
docker run \
--rm \
--name shazarr-api \
--platform=linux/amd64 \
-p 12358:12358 \
-e LIDARR_API_KEY=123456789abcdef \
-e LIDARR_URL=http://<lidarr-web-ui-url> \
-e LIDARR_LIBRARY_PATH=/music/ \
-e TIDARR_URL=http://<tidarr-web-ui-url>
You will find your lidarr music path in web ui :
2. Mobile App
Android
APK available here
iOS (coming soon)
Roadmap
- API usgin docker image
- Android app
- iOS app
Development
- Docker image for API services (ExpressJS + python)
- Android mobile app (ReactJS + Ionic/Capacitor)
Watch mode
Start api in watch mode :
make api/dev
Start android front in watch mode :
make android/dev
UI available on port 8100 http://localhost:8100/
Build
Build for android studio:
make android/build
Build API docker image:
make api/build
Credits
- Big thanks to the ShazamIO team for the awesome works 👏💪🙏
- UI inspiration : https://github.com/codrops/ShazamButtonEffect
- See Lidarr project: https://github.com/linuxserver/docker-lidarr
- See Tidarr project: https://github.com/cstaelen/tidarr
Description
Offroad Shazam Android app (iOs available on source build). Lidarr and Tidarr companion.
68 MiB
0 Stars
1 Watchers
0 Forks