Git Product home page Git Product logo

better-lyrics-api's Introduction

Better Lyrics API

GitHub top language GitHub License GitHub Actions Workflow Status Railway

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

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.

better-lyrics-api's People

Contributors

boidushya avatar ashinsabu3 avatar

Stargazers

Selman Yalçın avatar Ashin Sabu avatar Gabriel avatar avatar No NOréo avatar

Watchers

avatar avatar

Forkers

i-am-zaidali

better-lyrics-api's Issues

Backend TechDebt

Backend TechDebt

A few items which aren't high prio but we can re-evaluate later/ once we have time. If you want to work on any of these, feel free to create a new issue with what you'd like to work on and I'll add you as Assignee for that task.

  • Send proper error codes

Re-search using a different source for lyrics

image

I see that the lyrics of this song was incorrectly fetched for another song. Could we have an API which searches lyrics for the same song, but using a different source? And ultimately have a button on the page via the extension to allow the user to use that?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.