Skip to content

yoavain/lyricsify

Repository files navigation

CodeQL Actions Status types commit Known Vulnerabilities codecov Renovate visitors

Lyricsify - Player & lyrics

This is an audio player, that:

  1. Parses and shows lyrics embedded in files
  2. Fetches missing lyrics from various lyrics providers
  3. (Optionally) embeds lyrics in file

Lyrics providers:

  1. apiseeds.com (requires API token)

🏃‍♂️ Getting Started

Run the following commands to start the project:

git clone ...
cd <your-project-name>
npm install

The electron command in the package.json file is only used internally by the boilerplate to launch electron.

🏗️ How to Build the Project

Run npm run build. This will create a dist folder with:

  • A folder called app-win32-ia32 containing the executable file
  • A folder called installer containing the setup files to install the app

🌳 The Project Structure

  • 📁 public: Holds all your public assets, such as styles, images or fonts. Also holds the index.html
  • 📁 scripts: Holds the start and build script. This is where you can configure the setup
  • 📂 src
    • 📁 components: A place to hold your React components
    • 📁 electron: Includes the start scripts for a dev and prod Electron build

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published