diff --git a/README.md b/README.md index 8cb8256..65c161e 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,7 @@ Once installed, clone the repository and install its dependencies running: You will need to register your app and get your own credentials from the Spotify for Developers Dashboard. -To do so, go to [your Spotify for Developers Dashboard](https://beta.developer.spotify.com/dashboard) and create your application. In my own development process, I registered these Redirect URIs: - -- http://localhost:3000 (needed for the implicit grant flow) -- http://localhost:3000/callback +To do so, go to [your Spotify for Developers Dashboard](https://beta.developer.spotify.com/dashboard) and create your application. Once you have created your app, change the `client_id` and `client_secret` values in the a `app.js` file to your own Spotify Developer credentials. @@ -30,16 +27,16 @@ In order to run the app, open the folder, and run its `app.js` file: $ cd receiptifyv1 $ node app.js -Then, open `http://localhost:3000` in a browser. - -To allow users to access your app, you need to add their names and emails under user managment from the Spotify for Developers Dashboard. +The terminal will print the serverIP and port that the program is running on. -When hosting, set the Redirect URI as: -- http://[serverIP]:3000 (needed for implicit grant flow) +When hosting, you will need to set the Redirect URI in the Spotify for Developers Dashboard as: - http://[serverIP]:3000/callback Setting Redirect URI as http://localhost:3000/callback when trying to host the application for local clients to connect to will fail because the redirect URI points to the client's IP address (localhost). +To allow users to access your app, you need to add their names and emails (associated with their Spotify account) under user managment from the Spotify for Developers Dashboard. + +To open the app, just enter the serverIP and port number into a browser (ex. 10.188.203.159:3000). ## Joining the App Locally A user on the same network the app is hosted on can put the host's IP and port number into their browser (ex. 10.188.203.159:3000). @@ -48,7 +45,7 @@ The first person will click the "Create Session" button and log into their Spoti Other users can then click "Join Session" and after entering the shared Session ID, they can log into their Spotify accounts and view the receipt. -After refreshing the page, checkboxes will appear next to each joined user's name indicating which Spotify accounts data will be included. You can pick from viewing Top Tracks, Top Artists, Stats, and Top Genres (CURRENTLY ONLY WORKS FOR TOP ARTISTS, TRACKS, AND STATS). You can also change the time period data is drawn from and length of receipt. Under the receipt, you can download the image or open it in a new tab. +After refreshing the page, checkboxes will appear next to each joined user's name indicating which Spotify accounts data will be included. You can pick from viewing Top Tracks, Top Artists, Stats, and Top Genres. You can also change the time period that data is drawn from and length of the receipt. Under the receipt, you can download the image or open it in a new tab. Screenshot 2024-04-17 at 9 45 04 AM