Lyrist

playground . guide . twitter

Overview

Lyrist is a simple yet powerful RESTful API for getting lyrics of any song using the song's name and its artist's name. It's easy to use and just works. To prevent misuse of the API, every user is rate limited to 50 requests per hour based on their IP address.
You can play with the API here. Fun Fact: I had created this API as a starting project for learning Next.js.

Tech Stack

• Next.js as Framework.
• Tailwind CSS for Styling.
• LyricsDumper for getting lyrics.
• Vercel for Deploying.

Run locally

Clone the repository

$ git clone https://github.com/asrvd/lyrist.git

Install dependencies

$ cd lyrist
$ pnpm i // or npm

Set up environment variables

# Create a .env file with the following variables
UPSTASH_REDIS_REST_URL=your_upstash_redis_url
UPSTASH_REDIS_REST_TOKEN=your_upstash_redis_token
# Get these credentials by creating a free Redis database at https://upstash.com/

Run the app

$ pnpm run dev // or npm

Contributing

• Fork the repository.
• Make your changes in a separate branch.
• Open a pull request.

Contributors

Ending Note

• Consider giving the repo a ⭐ if you liked the project!
• Checkout my other projects!
• Consider sponsoring me to help me build more projects like this.