A Synced Lyrics Music Player built with TypeScript

26 May 2023
0
35

Synced Lyrics Music Player

This project is a music player with live, synced lyrics. The frontend is built using Vite React App and the backend is built using Express. Live, synced lyrics are provided by the sync-lyrics package.

Installation

To install the project, follow these steps:

Clone the repository to your local machine:

git clone https://github.com/samocodes/synced-lyrics-music-player.git

Install the dependencies for both the frontend and backend:

cd synced-lyrics-music-player
yarn

Edit the .env file.
Start the server:

yarn start

This will start the app in development mode. Open http://localhost:5173 to view it in the browser.

Usage

The synced lyrics music player allows you to play music with live, synced lyrics. To get started, simply:

Add music file to backend/music directory. And put the data in backend/data.ts
Start playing the music and the lyrics will be displayed in real-time, synced to the music.

You can also control the playback of the music using the player controls, such as play/pause, and adjust the volume.

Contributing

If you would like to contribute to the project, feel free to submit a pull request. Before submitting a pull request, please ensure that your code follows the project’s coding standards and that all tests pass.