https://github.com/rahuletto/lirics

Lirics is a self-hosting service that brings real-time Spotify lyrics to your screen with a beautiful, Apple Music-like aesthetic.
https://github.com/rahuletto/lirics

api lyrics spotify

Last synced: 9 months ago
JSON representation

Lirics is a self-hosting service that brings real-time Spotify lyrics to your screen with a beautiful, Apple Music-like aesthetic.

Host: GitHub
URL: https://github.com/rahuletto/lirics
Owner: Rahuletto
License: apache-2.0
Created: 2024-04-01T15:28:30.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-06-14T10:02:02.000Z (about 2 years ago)
Last Synced: 2025-02-08T01:42:26.293Z (over 1 year ago)
Topics: api, lyrics, spotify
Language: TypeScript
Homepage: https://lirics.vercel.app
Size: 6.11 MB
Stars: 7
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# lirics
Lirics is a self-hosting service that brings real-time Spotify lyrics to your screen with a beautiful, Apple Music-like aesthetic.
> As spotify made lyrics into a premium feature, I came up with this cool idea to display accurate timed-lyrics in Apple Music style.

> [!IMPORTANT]
> Thanks to [LRCLib](https://lrclib.net) api for providing lyrics

### Features
- Real-Time Lyric Display: See the lyrics of your favorite songs in real time as they play on Spotify.
- Playback Control: Spotify Premium users can control playback directly from the app.
- Interactive Lyrics: Click on any line of lyrics to jump to that specific part of the song.
- Advanced Navigation: Easily seek 10 seconds forward or backward with intuitive controls.
- PWA Support! Install the website as an app in supported browsers

### Installation
To get started with Lirics, follow these steps:

- Clone the repository: git clone https://github.com/Rahuletto/lirics.git
- Navigate to the project directory: cd lirics
- Get Spotify API key from [Spotify developer dashboard](https://developer.spotify.com/dashboard)
- Setup the `.env` with the `NEXTAUTH_SECRET`, `SECRET`, `CLIENT_ID`, `REDIR`, `NEXTAUTH_URL` variables, Where
- - `NEXTAUTH_SECRET` is the [Encryption key for JWT](https://next-auth.js.org/configuration/options#secret) (haha fancy term?)
- `SECRET` and `CLIENT_ID` from Spotify api
- `REDIR` would be `https://{URL}/api/auth/callback/spotify` where URL is your hosted/localhost website
- `NEXTAUTH_URL` is self-explanatory, its the url of your site.
- Install the necessary dependencies:
```
npm install
```
- Start the application:
```
npm run build && npm run start
```

Once installed, you can access Lirics from your web browser. Ensure you have a Spotify Premium account to utilize playback controls within the app, other than that you can see timed lyrics without any subscription.

This can **only** be self-hosted as Spotify didnt approve my application for the API to be used by public
> Your application would be rejected if requested to be published to public for the reason `Synchronization: Spotify content is used in the background of visual media, such as advertising, film, TV programs, livestreams, slideshow videos, lyrics (etc.)`

> [!WARNING]
> This is not affiliated to Spotify

### Screenshots

Lyrics
| Desktop | Mobile |
| ------- | ------ |
| | |