mirror of
https://github.com/cstaelen/shazarr.git
synced 2026-10-19 01:31:11 -05:00
103 lines
5.1 KiB
Markdown
103 lines
5.1 KiB
Markdown
[](https://github.com/cstaelen/shazarr-app)
|
|
[](https://github.com/cstaelen/shazarr-app/releases)
|
|
[](https://github.com/cstaelen/shazarr-app/releases)
|
|
|
|
[](https://github.com/cstaelen/shazarr/releases/latest/download/shazarr-signed.apk)
|
|
<a href="https://www.buymeacoffee.com/clst" target="_blank" title="Buy Me A Coffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 28px !important;width: 110px !important;" ></a>
|
|
|
|
# Shazarr - Unofficial Shazam mobile app web UI
|
|
Shazarr project is a mobile app (android, ios) providing Shazam song recognition service with [Lidarr](https://github.com/linuxserver/docker-lidarr) and [Tidarr](https://github.com/cstaelen/tidarr) integration.
|
|
|
|
|
|
## Features
|
|
- Audio microphone capture and song recognition using reverse Shazam API with [node-shazam-api](https://github.com/asivery/node-shazam-api).
|
|
- Download discovered album with [Lidarr](https://github.com/linuxserver/docker-lidarr), auto-search via API (with browser fallback if no API key)
|
|
- Download discovered track or album with [Tidarr](https://github.com/cstaelen/tidarr), search Tidal content in-app, pick the album, queue track or full album download, or with Tidarr 1.2.1 or higher, add track to Tidal favorites
|
|
- Add to [SoulSync](https://github.com/Nezreka/SoulSync) wishlist to trigger automatic download (via API)
|
|
- Add custom search service
|
|
- Listen on streaming app Spotify, Apple Music and Deezer
|
|
- Show lyrics
|
|
- Offline mode : record and recognize later (if network down)
|
|
- Records history
|
|
- Privacy: No login, no tracking, no API key
|
|
|
|
## Screenshots
|
|
|
|
<img src="https://github.com/cstaelen/docker-shazarr/blob/b436440b628ff5c8a0925a57e63e6659b1bf273e/.github/screenshot.jpg" />
|
|
|
|
## Get started
|
|
|
|
- **Android**: ✅ APK Download APK [here](https://github.com/cstaelen/shazarr/releases/latest/download/shazarr-signed.apk)
|
|
- **iOS**: ⚠️ build app from Xcode ONLY (needs xcode and paired device)
|
|
|
|
Get last release :
|
|
|
|
[<img src="https://github.com/cstaelen/shazarr-app/blob/4465b4d6532a4ade3a970be2b9ade3705706e50f/.github/qr-release.png" width="100" />](https://github.com/cstaelen/shazarr-app/releases/latest)
|
|
|
|
### App options (fit with your data)
|
|
|
|
- **Lidarr URL** : `http://<lidarr-web-ui-url>`
|
|
- **Tidarr URL**: `http://<tidarr-web-ui-url>`
|
|
- **SoulSync URL**: `http://<soulsync-web-ui-url>:8008`
|
|
- **SoulSync API Key**: `your-api-key` (generated from SoulSync settings)
|
|
- **SoulSync Profile ID**: `1` (optional, defaults to 1)
|
|
- **Custom service URL**: `http://<service-url>?query=`
|
|
- **Custom service name**: `My custom music service`
|
|
|
|
#### iOS ( /!\ source build only )
|
|
Requirements: `pnpm`, `xcode`.
|
|
|
|
1. Git clone project first
|
|
2. in project folder run:
|
|
```
|
|
cd docker-shazarr
|
|
pnpm run ios:build
|
|
```
|
|
XCode should open project.
|
|
|
|
3. [Pair your iOS device](https://developer.apple.com/documentation/xcode/running-your-app-in-simulator-or-on-a-device/#Connect-real-devices-to-your-Mac)
|
|
4. build the app.
|
|
5. After few secs, it should be installed on your ipad/iphone.
|
|
|
|
## Roadmap
|
|
- [x] Android app
|
|
- [x] Record history: access last shazamed songs
|
|
- [x] Offline record: record without API access, recognize song later
|
|
- [x] Update notifications
|
|
- [ ] iOS app: find a way to distribute packaged app without using app store and without have to clone and build it
|
|
|
|
## Development
|
|
- Android + iOS mobile app (ReactJS + Ionic/Capacitor)
|
|
|
|
### Watch mode
|
|
Start app in watch mode :
|
|
```sh
|
|
pnpm run start # Listening on http://localhost:3000/
|
|
pnpm run android:live # Listening on http://localhost:8100/ + emulate
|
|
pnpm run ios:live # Listening on http://localhost:8100/ + emulate
|
|
```
|
|
|
|
### Build
|
|
Build APK with Android studio:
|
|
```
|
|
pnpm run android:build
|
|
```
|
|
Build ios app with Xcode:
|
|
```
|
|
make ios/build
|
|
```
|
|
|
|
## Support
|
|
|
|
If you like this project you can support here:
|
|
|
|
<a href="https://www.buymeacoffee.com/clst" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="40" width="160"></a>
|
|
|
|
## Credits
|
|
- Big thanks to the [node-shazam-api](https://github.com/asivery/node-shazam-api) team for the awesome works and reactivness 👏💪🙏
|
|
- UI inspiration : https://github.com/codrops/ShazamButtonEffect
|
|
- See Lidarr project: https://github.com/linuxserver/docker-lidarr
|
|
- See Tidarr project: https://github.com/cstaelen/tidarr
|
|
- See SoulSync project: https://github.com/Nezreka/SoulSync
|
|
|