diff --git a/README.md b/README.md index b0d910d..0ca8a2a 100644 --- a/README.md +++ b/README.md @@ -31,24 +31,84 @@ The app is designed to make the playlist conversion process as straightforward a --- -## 🖼️ Screenshots - -*(TBD)* - ---- - ## How to Run the Project -*(TBD)* +1. **Set Up Environment Variables** + - Obtain Spotify Developer credentials (Client ID and Client Secret) from the [Spotify Developer Portal](https://developer.spotify.com/dashboard/). + - Generate a Google API Key from the [Google Cloud Console](https://console.cloud.google.com/). + - Obtain YouTube credentials (Client ID and Client Secret) from the [Google Cloud Console](https://console.cloud.google.com/). + - Create a `.env` file in the root directory using the format in `env.example`: + ```env + clientID="🩷" + clientSecret="💜" + GOOGLE_API_KEY="💛" + + SPOTIFY_CLIENT_ID="💚" + SPOTIFY_CLIENT_SECRET="🧡" + ``` + +2. **Install Dependencies** + - Ensure Python v3 is installed on your system. + - Open a terminal, navigate to the `backend/api` folder by running: + ```bash + cd backend/api + ``` + - Install the required Python dependencies by running: + ```bash + pip install -r requirements.txt + ``` + +3. **Run the Application** + Open **two terminals**: + + - **Terminal 1:** + - From the root directory of the project, navigate to the `backend/api` folder: + ```bash + cd backend/api + ``` + - Start the Flask server: + - On Mac: + ```bash + python3 flask-server.py + ``` + - On Windows: + ```bash + python flask-server.py + ``` + + - **Terminal 2:** + - From the root directory of the project, navigate to the `frontend` folder: + ```bash + cd frontend + ``` + - Install the required Node.js dependencies by running: + ```bash + npm install + ``` + - Start the Svelte development server: + ```bash + npm run dev + ``` + +4. **Use the Application** + - Open a browser and navigate to the provided URL (usually `http://localhost:3000`). + - Click **Login to Spotify** to authenticate. + - Select a playlist and click **Submit Playlist**. + - Click **Login to YouTube**, and you'll be redirected to a success page. + - Check your YouTube account for the exported playlist. + +**Note:** Both terminals must remain running simultaneously for the application to work. ---- -## Key Features +--- -- **Easy Playlist Transfer:** Move your music effortlessly between Spotify and YouTube with minimal input. -- **Accurate Song Matching:** Leverages song titles and artist names to find the closest matches on YouTube. -- **Dynamic Playlist Creation:** Automatically generates and saves a YouTube playlist with the selected songs. -- **Responsive Design:** Enjoy a user-friendly interface on both desktop and mobile devices. +## 🖼️ Screenshots +Screenshot 2024-12-10 at 7 51 38 PM +Screenshot 2024-12-10 at 7 52 18 PM +Screenshot 2024-12-10 at 7 52 38 PM +Screenshot 2024-12-10 at 7 53 01 PM +Screenshot 2024-12-10 at 7 53 55 PM +Screenshot 2024-12-10 at 7 54 37 PM ---