docs: update the getting-started guide

This commit is contained in:
Kingkor Roy Tirtho 2023-09-14 22:30:59 +06:00
parent 806b22ec85
commit 79a371f9b1

View File

@ -1,7 +1,7 @@
---
title: Getting Started With Spotube
cover_image: https://github.com/KRTirtho/spotube/raw/master/assets/spotube-screenshot.png
date: "July 16, 2022"
date: "September 14, 2023"
author: Kingkor Roy Tirtho
author_avatar_url: https://avatars.githubusercontent.com/u/61944859?v=4
tags:
@ -16,52 +16,27 @@ So installing Spotube is done. Its a new app & although most of the things ca
The most common issue with Spotube when someone uses it for the first is with its Login mechanism. Spotube is a Spotify client. And Spotify clients usually require *Premium Accounts* as the Spotify Server only allows premium accounts to download music. But **in Spotube you dont need a Premium Account**
Since Spotube doesnt require premium accounts it needs to special workarounds to supply the Music for Free. Thus, the Login mechanism in Spotube is a bit lengthy, but its actually more secure than any other Spotify Clients as the data stays in your Account & doesnt need to go through a middleware unlike other Spotify Clients
### Android Login
It's super easy to login with Spotify account in Spotube Android version. Just tap on the "⚙️ Settings" > "Connect with Spotify" button & it'll navigate to official Spotify login page where user can enter their credentials safely & get logged in
Now, lets get through the login Part. For Login, youll need two special things
### Desktop Login
Unfortunately, there's currently no way to run webview inside Flutter apps in desktop. Thus the user have to manually get the cookies from [accounts.spotify.com](https://accounts.spotify.com)
Just like Android, go to "⚙️ Settings" > "Connect with Spotify". Now it'll open a login page that accepts `sp_dc` & `sp_key` or `sp_gaid` cookie values
There's already a button named ***"Follow along the Step by Step guide"*** to open the tutorial on how to get these cookies
Although there's a tutorial available in the app, here's a quick guide on how to get these cookies
- Client ID
- Client Secret
**What is a Client ID?**
Client ID is kind of a Public key (ID) that is a unique identifier for the Spotify API client & is usually used to pair with Client Secret
**What is a Client Secret?**
A client secret is **a secret known only to the application instance and the authorization server**. It protects Spotify Data by only granting tokens to authorized requestors
Now In Spotube, tap on the Settings Icon in the Sidebar/Bottom Bar & click on the **Login With Spotify** button.
Now youll have to open a browser & have to go to [developers.spotify.com/dashboard](https://developers.spotify.com/dashboard) & press the Login button
![step-1.png](https://rawcdn.githack.com/KRTirtho/spotube/0e10ddfa54113eb559308be1eb976b707dd7410c/assets/tutorial/step-1.png)
After Login, create a Spotify Developer App by clicking on the CREATE AN APP button. Give the App a name & description & hit CREATE. Finally, the view will look somewhat similar to below
![step-2.png](https://rawcdn.githack.com/KRTirtho/spotube/0e10ddfa54113eb559308be1eb976b707dd7410c/assets/tutorial/step-2.png)
Now comes the **Most Important Part…**
First Tap on the App to enter the dashboard page. In there, tap EDIT SETTINGS & a Dialog with multiple configuration will Open
![step-3a.jpg](https://rawcdn.githack.com/KRTirtho/spotube/0e10ddfa54113eb559308be1eb976b707dd7410c/assets/tutorial/step-3a.jpg)
Now find the **Redirect Uris** and type/paste `http://localhost:4304/auth/spotify/callback` in the field and press Add. Finally scroll down to the bottom section of the Dialog and press the SAVE button to save the changes
![step-3b.jpg](https://rawcdn.githack.com/KRTirtho/spotube/0e10ddfa54113eb559308be1eb976b707dd7410c/assets/tutorial/step-3b.jpg)
Now close the Dialog & see in the Left/Below of the EDIT SETTINGS button, there youll find **Client ID** and a SHOW CLIENT SECRET button. Copy the *Client ID* & paste it in the Spotubes Text Field. Then tap/click on the SHOW CLIENT SECRET button to reveal the **Client Secret.** Finally, copy the **Client Secret** & paste it in the Spotubes corresponding Text Field
![step-4.jpg](https://rawcdn.githack.com/KRTirtho/spotube/0e10ddfa54113eb559308be1eb976b707dd7410c/assets/tutorial/step-4.jpg)
Finally, press on the *Submit Button* which will open a Browser Window/Tab (desktop) or a Browser Application (android). Press/Click ALLOW button in that page & now youre successfully Logged In with your Spotify Account in Spotube
Close the Browser Tab (optional) & Go back to Spotube and Enjoy your lifetime (probably) free Music
1. Open [accounts.spotify.com](https://accounts.spotify.com) in your browser
1. Login with your Spotify account
1. Open the Developer Tools (F12)
1. Chrome/Chrome-based browsers: Go to Application Tab
1. Firefox: Go to Storage Tab
1. Find the Cookies section & copy the values of `sp_dc` & `sp_key` or `sp_gaid` cookies
1. Paste the values in the respective fields in Spotube & press the "Login" button
1. Done! You're logged in
## Playing Playlists & Tracks
You can play any playlists in the Home Screen of Spotube just by pressing the Play button of the playlist. But this is not just it. You can also play any playlist from starting from any track of the playlist and this available in all platform unlike Spotify which doesn't allow this kind stupid simple stuff in the Mobile App
You can play any playlists in the Home Screen of Spotube just by pressing the Play button of the playlist. But this is not just it. You can also play any playlist from starting from any track of the playlist and this available in all platform unlike Spotify which doesn't allow this kind stupid simple stuff in the Mobile App.
Just tap on any Playlist's Cover Image & from the track list, tap the little Play button next to the track from which you want the playlist to start playing.
![Bpfau.png](https://s6.imgcdn.dev/Bpfau.png)
@ -69,7 +44,7 @@ Just tap on any Playlist's Cover Image & from the track list, tap the little Pla
## Sing along with any Song with **Synced Lyrics** just like Karaoke
Yes, Spotube support Synced Lyrics too (most of the popular English songs). So, if you wanna sing along with your favorite Music Track but don't know the Lyrics Spotube got you covered & now even you can sing along. Here's how, just play any playlist/album/track & press on the Lyrics Tab in the Sidebar (desktop/tablet) or Bottom Bar (mobile) & the Synced Lyrics will automatically start playing with the Audio Track
Yes, Spotube support Synced Lyrics too. So, if you wanna sing along with your favorite Music Track but don't know the Lyrics Spotube got you covered & now even you can sing along. Here's how, just play any playlist/album/track & press on the Lyrics Button in the Sidebar (desktop/tablet) or inside Player Page (mobile) & the Synced Lyrics will automatically start playing with the Audio Track
![BpttL.png](https://s6.imgcdn.dev/BpttL.png)