Skip to content

Commit 5d5a96c

Browse files
authored
Merge pull request #1088 from eliecharra/add_api_key_doc
Add doc to setup a valid api key
2 parents 9fa7a8e + 28eb757 commit 5d5a96c

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ It's built with Electron, Node.js, Angular.js, and uses the Soundcloud API.
1010
1111
Follow us on twitter for updates [@Soundnodeapp](https://www.twitter.com/soundnodeapp).
1212

13-
Featured on [Producthunt](https://www.producthunt.com/tech/soundnode-2), [TNW](http://thenextweb.com/apps/2016/01/25/soundnode-is-the-soundcloud-desktop-app-youve-been-waiting-for/#gref)
13+
Featured on [Producthunt](https://www.producthunt.com/tech/soundnode-2), [TNW](http://thenextweb.com/apps/2016/01/25/soundnode-is-the-soundcloud-desktop-app-youve-been-waiting-for/#gref)
1414
and [Gizmodo](http://gizmodo.com/soundnode-turns-soundcloud-into-a-spotify-like-desktop-1754953529)
1515

1616
![alt tag](https://raw.githubusercontent.com/Soundnode/soundnode-app/master/Soundnode-app.png)
@@ -28,6 +28,17 @@ and [Gizmodo](http://gizmodo.com/soundnode-turns-soundcloud-into-a-spotify-like-
2828

2929
And much more!
3030

31+
## Configuration
32+
33+
Since soundcloud apply rate limit to third party app you need to configure your own API key to make soundnode work.
34+
35+
Unfortunatly soundcloud suspended new application creation, so to retrieve your api key, you have to dig into soundcloud website.
36+
37+
* Login to soundcloud.com on favorite browser
38+
* Look for and api call and write down the client_id parameter
39+
![dev tools](doc/img/dev_tools.png)
40+
* Edit your userConfig.json file (see here for location : https://github.com/eliecharra/soundnode-app/blob/master/app/public/js/common/configLocation.js#L34) and update clientId parameter with the previously retrieved one.
41+
3142
## How to contribute
3243

3344
First, building, testing, and reporting bugs is highly appreciated. Please include console's output and steps to reproduce the problem in your bug report if possible.

doc/img/dev_tools.png

90.8 KB
Loading

0 commit comments

Comments
 (0)