Skip to content

A modern web interface for SimpMusic Lyrics API - Search, view, and manage song lyrics with a beautiful, responsive UI.

License

Notifications You must be signed in to change notification settings

maxrave-dev/lyrics-web

Repository files navigation

SimpMusic Lyrics

License: MIT Next.js TypeScript Tailwind CSS

🎡 A modern web interface for SimpMusic Lyrics API - Search, view, and manage song lyrics with a beautiful, responsive UI.

Features

Smart Search

  • Full-text search across lyrics content
  • Artist search to find songs by specific artists
  • Song title search for exact matches
  • Real-time search with instant results
  • Request timing display for performance transparency

Modern UI/UX

  • Responsive design optimized for mobile and desktop
  • Dark/Light theme support with system preference detection
  • Beautiful typography with optimized font loading
  • Smooth animations and transitions
  • Clean, minimalist interface inspired by modern music apps

Lyrics Management

  • Lyrics viewer with synced and plain lyrics support
  • Community translations with language chips
  • Vote system for lyrics quality (upvote/downvote)
  • Download lyrics as LRC files
  • Contributor attribution and vote counts
  • Toast notifications for user feedback

Security & Performance

  • HMAC authentication for API requests
  • Rate limiting awareness and error handling
  • Real-time vote updates without page refresh
  • Optimized API calls with proper caching
  • Error boundaries and graceful error handling

Quick Start

Prerequisites

  • Node.js 18+
  • npm/yarn/pnpm/bun

Installation

# Clone the repository
git clone https://github.com/maxrave-dev/lyrics-web.git
cd lyrics-web

# Install dependencies
npm install
# or
yarn install
# or
pnpm install
# or
bun install

Development

# Start development server
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 in your browser.

Build for Production

# Build the application
npm run build
# or
yarn build

# Start production server
npm start
# or
yarn start

Tech Stack

Frontend Framework

Styling

Related Projects

This web interface connects to the SimpMusic Lyrics API:

Backend API

SimpMusic App

  • Repository: maxrave-dev/SimpMusic
  • Platform: Android (Jetpack Compose)
  • Description: FOSS YouTube Music client with lyrics integration

πŸ“ Project Structure

src/
β”œβ”€β”€ app/                 # Next.js App Router
β”‚   β”œβ”€β”€ about/          # About page
β”‚   β”œβ”€β”€ api/            # API documentation
β”‚   β”œβ”€β”€ donate/         # Donation page  
β”‚   β”œβ”€β”€ search/         # Search page
β”‚   └── layout.tsx      # Root layout
β”œβ”€β”€ components/         # React components
β”‚   β”œβ”€β”€ ui/            # shadcn/ui components
β”‚   β”œβ”€β”€ LyricsDialog.tsx # Main lyrics viewer
β”‚   β”œβ”€β”€ Header.tsx     # Navigation header
β”‚   └── Footer.tsx     # Page footer
β”œβ”€β”€ lib/               # Utilities
β”‚   β”œβ”€β”€ hmac.ts       # HMAC authentication
β”‚   β”œβ”€β”€ config.ts     # Configuration
β”‚   └── utils.ts      # General utilities
└── hooks/            # Custom React hooks

Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Development Workflow

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes: git commit -m 'Add amazing feature'
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request

Code Style

  • TypeScript for type safety
  • ESLint + Prettier for code formatting
  • Conventional Commits for commit messages
  • Component-driven development

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support & Donations

Special thanks to all supporter ❀️

Visit the website Β  Discord Server Β 
Buy me a Coffee Β  liberapay

MOMO or Vietnamese banking

SimpMusic is sponsored by:


Vercel OSS Program

DigitalOcean Referral Badge




Get a free $200 credit over 60 days on DigitalOcean: GET NOW

Crowdin and Sentry both have a free enterprise plan for Open-source projects. Follow the URLs:

Check out the Vercel open-source program:

This project is a part of SimpMusic.org Open-source project by me maxrave-dev

About

A modern web interface for SimpMusic Lyrics API - Search, view, and manage song lyrics with a beautiful, responsive UI.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published