Open Scrobbler

What is this?

An open source scrobbling client for the web. Just login and scrobble the track(s) you want! This tool lets you scrobble songs you heard on the radio, vinyls or at some place where you need to manually scrobble.

You may use it directly from here: https://openscrobbler.com/

What is scrobbling, you ask? It's tracking the music you listen to, using last.fm.

Help us make it better!

You can support development by becoming a Patron (you'll have a distinct identifier in the application, get a sneak peek into what's coming next, and a few extra features! ✨ )

Contributing

Contributions and suggestions are welcome. Please read the contribution guidelines for more information. Issues labeled with "help wanted" are great candidates if you don't know where to begin!

Translations

To join the translators team, follow the link at the bottom of the language selector in the application ("Want to add your language?").

Development setup

• Clone the repository
• Copy .env to .env.development.local, then set at least the required variables
  • You'll need a Last.fm API account to be able to interact with Open Scrobbler (it's used for authentication and queries). Once you have your keys, fill in REACT_APP_LASTFM_API_KEY and LASTFM_API_KEY (same value in both) and LASTFM_SECRET
  • Optional: to interact with Discogs, create a Discogs application to get API keys and fill in DISCOGS_API_KEY and DISCOGS_SECRET
  • Optional: to interact with Setlist.fm, create an application and set SETLISTFM_API_KEY with the corresponding API key
• Run yarn to download the required libraries.
• Run yarn start to initialize the docker container and run the application.

Testing

You will need to copy cypress.env.json to cypress.development.json and update the file to execute the tests. Don't use last.fm account credentials from a real account!

Tests can be run with yarn test, Cypress console can be accessed with yarn cypress.

To check test coverage run yarn test:coverage

Running the application

Just start it with yarn start (it will launch both the API server and the React application).

Building

The build script should be enough! :)

Thank you!

One of the best things about open source is the great community around it. Open Scrobbler has several contributors and each one of them has made this tool better for everyone. Thanks to all of them!