8000 GitHub - AlexKazz/lazy-lyrics-app
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

AlexKazz/lazy-lyrics-app

Repository files navigation

Lazy Lyrics

www.lazy-lyrics.io

Do you enjoy writing lyrics, but struggle with writer's block? Or maybe you just want to write lyrics faster?
Then Lazy Lyrics is the app for you! Enter a word, and get back a lyric snippet from a real song.


Built With

  • Javascript
  • React.js
  • Redux.js
  • Node.js
  • Express.js

Table of Contents

How It Works

• Lazy Lyrics uses the Musixmatch API to grab lyric snippets based on text input.

• Due to API method parameter and data limitations, this process must be done in two separate API calls.

• When you submit a word, an API call is made from the Lazy Lyrics server (built on express) to the Musixmatch API.

• Information including artist, song title, and track ID are returned.

• The track ID is then used to make a second Musixmatch API call to grab the lyric snippet.

• Lazy lyrics generates a random index and random page number for each submission to provide ~100 different results for the same word.

As this app is currently for personal use (not financed 🤷‍♂️), it is subject to Musixmatch API daily data limits. If you submit a word and nothing is returned, the data limit has been reached for that day and you can try again tomorrow.

(back to top)

How To Use

• Type in a word.
• Get back a lyric, in addition to the song title, artist, and your prompt.
• Hover over a lyric to delete it.
• On a mobile device, select a lyric to view the song info and delete option.
• The "Copy All" button copies all of your lyrics to your clipboard.
• The "Delete All" button deletes all of your lyrics.
• The "Question Mark" button opens a sidebar that contains information about Lazy Lyrics.
• The Moon/Sun button switches the app colors to Dark/Light mode.
• The "GitHub" button links to this repository.

(back to top)

Roadmap

  • Build the UI
  • Develop the API logic
  • Write some weird lyrics
  • Replace React Hooks with Redux Toolkit
  • Fix various grammatical errors in API responses
  • Replace API calls with AI generated lyrics
    • Build the machine learning model

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Run Locally

Getting started is easy! Just follow the steps below to get a local copy up and running.
You will need to create a (free) Musixmatch account for your own API key.

Prerequisites

  • npm
    npm install
  • Musixmatch account

Installation

  1. Clone the repo
    git clone git@github.com:AlexKazz/lazy-lyrics-app.git
  2. Install NPM packages
    npm install
  3. Create .env file in root folder containing the following:
    MY_KEY=<your musixmatch api key>
  4. Start the servers
    npm run dev
  5. Open the app in your browser
     http://localhost:3000/

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

0