Get the extension on the Chrome Store or GitHub
- Run Backend Locally
- Set up base files
- Install Python3
- Install ffmpeg
- Create Spotify dev account
- Obtain AudD.io API key
- Set environment variables
- Run the application
- Installing Chrome Extension
- Releases
Note: These steps are listed for developmental purposes. It is not necessary to run the backend locally on your machine in order for the Chrome extension to function as the extension is already connected to our backend server.
-
Set up base files
$ git clone https://github.com/YouTube2Spotify/y2s.git $ cd backend $ npm install $ cp .env.sample .env
-
Install python3 (for
pytube
)- Install required python dependency:
pip3 install pytube
- Install required python dependency:
-
Install ffmpeg (for converting pytube vid files to mp3s for AudD.io's API)
- For MacOS:
brew install ffmpeg
- For MacOS:
-
Create Spotify developer account & app
- Visit this link and click CREATE AN APP.
- Enter your Application Name and Application Description and click Create.
- Click on your newly created app within the dashboard to find your Client ID and Client Secret.
- Set redirect uris to your extension's callback (ex. https://iigamqfeafobbpahkaiiammplhmeegga.chromiumapp.org/callback)
- The ID preceding
chromiumapp.org
must match your extension's unique ID. - You can obtain the ID of your extension by going to the extensions page in your Chrome browser. The developer mode toggle on the upper right of the page must be enabled to view extension IDs.
- The ID preceding
-
Obtain an API key from AudD
-
Set environment variables
- Open and edit
.env
PORT=
Whichever port you want the app to run onAUDDIO_API_KEY=
your AudD api keyODESLI_API_KEY=
your Odesli api key, if you have one
- Open and edit
-
Run the application!
npm start
-
(OPTIONAL) See step 5 of Installing the Chrome extension if you want to connect the Chrome extension to your local backend server
-
Go to
chrome://extensions/
in Chrome's URL bar -
Enable developer mode on the upper right hand corner of the page
-
Click Load unpacked on the upper left hand corner of the page after enabling developer mode
-
Navigate to the root of the extension's folder (
/frontend
) and load the extension -
(OPTIONAL) If you are running the backend server locally and want to connect the extension to it, change the URL in the fetch request of
getMusic()
located in/frontend/js/background.js
to your development server's local address
Current release: v1.1.0-stable
Release Notes:
- Adds Odesli API integration
Past releases:
Current release: v1.1.0-stable
Release Notes:
- Adds options menu
- Enable/disable debug messages
Past releases:
Y2S
is available under the MIT license. See the LICENSE for more info.