Better Lyrics API

This repository contains the source code for the official Better Lyrics API - primarily serving as the backend for Better Lyrics.

Note

A few endpoints are defined as environment variables in the .env file. This is deliberate to prevent abuse of the API and to ensure that the API is used responsibly. If you would like to use a similar API for your own project, consider using something like spotify-lyrics-api. This repository is intended to address privacy concerns and to provide a more transparent API for users.

Table of Contents

• Better Lyrics API
  • Table of Contents
  • Installation
  • Usage
  • API Endpoints
  • Contributing
  • License

Installation

To install and run the Lyrics API Go, follow these steps:

1. Clone the repository: git clone https://github.com/boidushya/better-lyrics-api.git
2. Navigate to the project directory: cd better-lyrics-api
3. Install the dependencies: go mod tidy
4. Copy the .env.example file to .env and update the environment variables as needed: cp .env.example .env
5. Start the server: go run main.go

Usage

Once the server is running, you can access the API endpoints to retrieve lyrics for songs.

API Endpoints

• GET /getLyrics?a={artist}&s={song}: Retrieves the lyrics for the specified artist and song.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the GPL v3 License. As long as you attribute me or Better Lyrics as the original creator and you comply with the rest of the license terms, you can use this project for personal or commercial purposes.