Lyricstify API

Discover time-synced Spotify lyrics.

Introduction · Installation · API Documentation · Roadmap · Contributing · License

Introduction

This is the backend API for discovering time-synced Spotify song lyrics that are used by Lyricstify.

Installation

Since this project is built on top of Node.js so you need to download and install it before start using this repository. Then, to install this repository you can follow these steps:

Clone this repository
Open the project directory and run the following command to install the required dependencies:
```
npm install
```
Copy the .env.example file to the .env
Inside the .env file, pay attention to SPOTIFY_COOKIE you need to fill it in based on your Spotify account cookie. Here is how you can get your cookie:
- Open your browser and open Developer Tools by clicking F12
- Navigate to the Network tab inside your Developer Tools
- Then visit https://open.spotify.com/ and make sure that you already logged in
- Inside the Network tab, see the first request to open.spotify.com
- Then see the Request Headers tab, and copy the cookie value inside it
You can set APP_ENV (development, testing, or production), APP_PORT, and optionally you can configure Redis connection via variables that have REDIS_ prefix
Finally, start the server using the following command:
```
npm run start
```

API Documentation

Please visit the following page to see the API documentation.

Roadmap

Please visit the following page to view the Lyricstify API roadmap. If the task hasn't been assigned to anyone yet and you'd like to try working on it, you're welcome to open a new PR or a draft. If you have other ideas that aren't on the roadmap, feel free to open a new issue.

Contributing

Please see this page for a detailed explanation of how you can contribute to this repository.

License

This application is licensed under the MIT license.