Skip to content

Latest commit

 

History

History
82 lines (55 loc) · 2.41 KB

README.md

File metadata and controls

82 lines (55 loc) · 2.41 KB

SoundFusion

SoundFusion is a music player app that finds tracks from various sources to create personal playlists (YouTube and SoundCloud at the moment).

The idea for this app was born from the desire to learn Electron and build my first desktop app ever.


Usage

You can download the app directly:

Mac OSX: zip | dmg

Windows: TODO...

Or if you fancy a more hands-on installation process then first clone this repo:

$ git clone [email protected]:Temzasse/soundfusion.git

Then install dependencies:

$ npm install

Next, in order for the app to work it needs API keys for YouTube and SoundCloud. Unfortunately at the moment SoundCloud doesn't issue any new API keys so you're better of downloading the app directly (check links above).

If you happen to have both of the API keys required you need to copy the config-template.js to config.js under src and put you keys there.

Finally, you can package the app:

$ npm run pack

After electron-builder is ready you will find the app under dist folder.

Disclaimer: YouTube doesn't allow using videos as music without showing the actual video. I might try to add the video element somewhere but at the moment this is purely a personal project for learning Electron and I feel that things are fine as they are.

Development

Install dependencies:

$ npm install

Copy src/config-template.js as src/config.js and fill in your API keys as described above.

Run app in dev mode:

$ npm run dev

And if you are on Windows:

$ npm run dev:win

NOTE: the app will most likely crash without valid API keys...

TODO

Fixes

  • Allow using only one of the sources if some of the API keys are missing / invalid.
  • App should not crash if one of the sources does not work.

Features

  • Shuffle.
  • Volume control.
  • Add more music sources (check out Bandcamp).
  • Feature suggestions are more than welcome :)