Skip to content

Mario-Mellek/Lyrical-Master

Repository files navigation

Lyrical Master

Netlify Status

Table of Contents

About

Lyrical Master is a web app built using React.js and bundled by Vite.js. React.js is a popular JavaScript library for building user interfaces, while Vite.js is a build tool that provides fast and efficient development and production builds.”. The app allows users to search for a specific song or artist, and displays matched results with full song titles. Users can select the right match to find the song's lyrics. The app also supports playing the selected song on YouTube and conditionally renders a SoundCloud link if available. It's fully responsive on all devices.

The App's Logo was Created for free on Canva.

Installation

To install, run npm i. To run the app, run npm run dev.

Dependencies

Some of the important dependencies used in this app are:

  • axios: A promise-based HTTP client for the browser and Node.js.
  • react: A JavaScript library for building user interfaces.
  • react-dom: Provides DOM-specific methods that can be used at the top level of your app and as an escape hatch to get outside of the React model if you need to.
  • react-router-dom: DOM bindings for React Router.
  • react-toastify: A React-based toast notification system.

APIs

This app uses the LyricsGenuis API from RapidAPI to fetch the song ID, lyrics, and info. it also uses the youtube data API to fetch the song's official video.

Environment Variables

The following environment variables should be set in a .env.local file in the main directory containing the necessary API keys:

  • VITE_API_KEY: Your RapidAPI API key.
  • VITE_G_API_KEY: Your YouTube Data API (Google Cloud) key.
  • VITE_SONG_API: The LyricsGenuis song search API URL.
  • VITE_LYRICS_API: The LyricsGenuis lyrics API URL.
  • VITE_INFO_API: The LyricsGenuis song info API URL.
  • VITE_VID_URL: The YouTube Data API URL.

Deployment

The app is hosted for free on Netlify: Visit webApp

License

This project is licensed under the MIT License.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published