diff --git a/README.md b/README.md index 555bc47..761abca 100644 --- a/README.md +++ b/README.md @@ -32,13 +32,15 @@ The project was developed using the following technologies and tools: - Vite – used as the development and build tool for the application - Git – used for version control and collaboration - Spotify API – used to fetch music data +- iTunes API - used to fetch preview of songs +- LRCLIB API - used to fetch lyrics of songs ## Choices and Reasoning ### Working with the Spotify API and Frontend Development A large part of the project involved both integrating the Spotify API and building the frontend of the application. -We wanted to understand how data is fetched from an external API, how the response is structured, and how that data can be used in the application. At the same time, we spent a significant amount of time developing the frontend ourselves using React and TypeScript. +We wanted to understand how data is fetched from an external API, how the response is structured, and how that data can be used within the application. At the same time, we focused on developing the frontend using React and TypeScript, with AI as a supporting tool throughout the development process. We worked with: @@ -115,7 +117,7 @@ VITE_SPOTIFY_CLIENT_ID=your_client_id VITE_SPOTIFY_CLIENT_SECRET=your_client_secret ``` -You can get these credentials by creating an app in the [Spotify Developer Dashboard](https://developer.spotify.com/dashboard). Do not commit the `.env` file to Git. +You can get these credentials by creating an app in the [Spotify Developer Dashboard](https://developer.spotify.com/dashboard). > **Note:** The version running on the virtual machine already has valid credentials configured. @@ -164,7 +166,7 @@ ChatGPT was used for: We chose to use AI mainly for this part of the project because we wanted to spend as much time as possible understanding the API integration ourselves. -### Images +### AI Images The images we added ourselves as part of the visual design of the application were generated using ChatGPT. @@ -174,7 +176,7 @@ Music data and images provided by Spotify are fetched through the Spotify API. Our experience was that AI was useful as a supporting tool during development, especially when working with the UI and visual elements. -By using ChatGPT for parts of the user interface, we were able to spend more time understanding how the Spotify API worked and how to fetch and use data from the API. +By using ChatGPT as a supporting tool for parts of the user interface, we were able to spend more time understanding how the Spotify API worked and how to fetch and use data from the API. At the same time, it was important to us not to simply copy solutions without understanding them. We therefore tried, as far as possible, to write and understand the code ourselves, and AI-generated suggestions had to be adapted to fit our own application. @@ -188,7 +190,7 @@ Through this project, we have gained more experience with: - TypeScript - TanStack Query - working with external APIs -- fetching and processing data from the Spotify API +- fetching and processing data from the Spotify API, iTunes API and LRCLIB API - handling asynchronous API requests - displaying API data in a user interface - version control with Git @@ -206,4 +208,5 @@ If the application were to be developed further, possible improvements could inc - adding more advanced filtering or sorting - improving error handling for API requests - improving responsiveness and support for different screen sizes -- adding more tests \ No newline at end of file +- adding more tests +- log in with a Spotify account to enable additional features available through the Spotify API. \ No newline at end of file