Soundcheck, a desktop Spotify mini player.

---

Archived

Archived as I have not really worked on this in a long while. In that time Spotify released their own desktop miniplayer. This doesn't quite fill the same purpose I had set out for in this project so I may pick it up again.

---

Development

If you want to run this project on your local system, see below.

Prerequisites

Before you start, make sure you have the following prerequisites installed:

• Node.js
• npm
• Rust

You can find more detailed information about the prerequisites in the Tauri documentation.

Getting started

To get started with development, follow these steps:

1. Fork this project.
2. Clone the repository to your local machine.

$ git clone https://github.com/<your_github_username>/soundcheck.git
$ cd soundcheck

3. Install project dependencies using npm:

$ npm install

4. Run the project in development mode.

$ npm run dev

Building

To build a production version of the app, follow these steps:

1. Create an app in the Spotify for Developers Dashboard (Guide)
2. Include your client id and the port of your localhost redirect uri in a .env file in the root directory.

SPOTIFY_CLIENT_ID=<your spotify client id>
SPOTIFY_REDIRECT_URI=http://localhost:<port number>

3. Create the production version of your app:

$ npm run build

It will detect your operating system and build a bundle accordingly. The result will be located in src-tauri/target/release. For more information about building applications for different platforms check out the official documentation

Build-time Options

Options specified in the .env file that determine varying behaviour of builds.

• REFRESH_RATE: The frequency that the playback state is refreshed (in ms). [Default: 5000]

License

MIT