{"id":32470671,"url":"https://github.com/d221/vocaloid-rate","last_synced_at":"2026-05-03T11:38:02.977Z","repository":{"id":319167125,"uuid":"1075008037","full_name":"D221/vocaloid-rate","owner":"D221","description":"Personal, self-hosted web application for tracking, rating, and exploring Vocaloid music rankings","archived":false,"fork":false,"pushed_at":"2026-04-29T21:26:07.000Z","size":15190,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-29T22:33:16.621Z","etag":null,"topics":["fastapi","japanese","music","sqlite","vocaloid"],"latest_commit_sha":null,"homepage":"https://d221.github.io/vocaloid-rate/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/D221.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-12T22:11:01.000Z","updated_at":"2026-04-29T21:24:04.000Z","dependencies_parsed_at":"2025-10-18T09:19:18.806Z","dependency_job_id":"19812a73-c596-4a02-8ac4-44d1825b1816","html_url":"https://github.com/D221/vocaloid-rate","commit_stats":null,"previous_names":["d221/vocaloid-rate"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/D221/vocaloid-rate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/D221%2Fvocaloid-rate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/D221%2Fvocaloid-rate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/D221%2Fvocaloid-rate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/D221%2Fvocaloid-rate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/D221","download_url":"https://codeload.github.com/D221/vocaloid-rate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/D221%2Fvocaloid-rate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32567918,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastapi","japanese","music","sqlite","vocaloid"],"created_at":"2025-10-26T16:19:40.283Z","updated_at":"2026-05-03T11:38:02.959Z","avatar_url":"https://github.com/D221.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vocaloid Rate\n\n\u003e **Web Version:** Access the application at [vocaloid-rate.vercel.app](https://vocaloid-rate.vercel.app/).\n\u003e\n\u003e - **Note on Performance:** The web version may be significantly slower than running the application locally via the downloadable `.exe` due to cloud database latency.\n\u003e - **User Accounts:** You can create an account and log in. Passwords are securely hashed and encrypted.\n\u003e - **Privacy:** Emails are only used as usernames; we do not send any emails (including password resets). You can use a dummy email address if you prefer.\n\n![Vocaloid Rate Screenshot](assets/main.png)\n\nVocaloid Rate is a personal, self-hosted web application for tracking, rating, and exploring Vocaloid music rankings. It scrapes data from [Vocaloard](https://vocaloard.injpok.tokyo/en/), providing a clean and feature-rich interface to manage your personal collection of rated tracks and playlists.\n\nThe application is built with a Python/FastAPI backend and a optimized vanilla JavaScript frontend using Tailwind CSS.\n\n## Features\n\n- **Dynamic Track Table:** View the latest Top 300 Vocaloid tracks with powerful sorting and filtering.\n- **Personal Ratings \u0026 Notes:** Rate songs on a 1-10 star scale and add personal notes, all saved locally.\n- **Interactive Filtering:**\n  - Filter by text search for Title (EN/JP), Producer, and Voicebank.\n  - Filter by your rating status (Rated, Unrated, All).\n  - Filter by chart status (On Chart vs. Expired/Archived).\n- **Custom Playlists:**\n  - Create and manage multiple personal playlists.\n  - Add or remove tracks from any playlist with a single click.\n  - Use a drag-and-drop editor to set a custom order for your playlists.\n  - Import and Export single playlists to share with others.\n- **Dedicated Rated Tracks Page:** A dashboard view of all your rated songs, featuring detailed statistics.\n- **Advanced Statistics:**\n  - View your average and median ratings.\n  - See your Top 10 favorite producers and voicebanks.\n  - Interactive rating distribution chart to filter tracks by a specific score.\n- **Rich Media Integration:**\n  - Integrated music player with both audio-only and embedded video modes.\n  - Player controls for shuffle, repeat, and volume.\n  - Fetch and display song lyrics from the VocaDB API.\n- **UI/UX:**\n  - Light and Dark mode with automatic system preference detection.\n  - Fully responsive design that adapts from desktop to a mobile-friendly card layout.\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eClick to see more screenshots\u003c/strong\u003e\u003c/summary\u003e\n\n### Embed Playback (main feature)\n\n![Embed View](assets/embeds.png)\n\n### Filtering and Sorting\n\n![Filter View](assets/filter.png)\n\n### Ratings Page\n\n![Ratings View](assets/ratings.png)\n\n### Options Mode\n\n![Options Mode](assets/options.png)\n\n### Playlists\n\n![Playlist List View](assets/playlists.png)\n\n### Playlist Editor\n\n![Playlist Edit View](assets/playlist-edit.png)\n\n### Mobile UI\n\n![Mobile View](assets/mobile.png)\n\n\u003c/details\u003e\n\n## Deployment Options\n\nVocaloid Rate supports two primary deployment modes:\n\n### 1. Self-Hosted (SQLite)\n\nThis is the default mode, ideal for local use or hosting on a private server (e.g., via Docker).\n\n- **Database:** SQLite (stored in `data/tracks.db`).\n- **Setup:** Just run the application. No additional configuration is required.\n- **Persistent Data:** Ensure the `data` directory is persisted.\n\n### 2. Cloud Deployment (Vercel + Postgres)\n\nThe application is pre-configured for deployment on Vercel using a PostgreSQL database (e.g., Vercel Postgres, Supabase, or Railway).\n\n- **Database:** PostgreSQL (or any other DB supported by SQLAlchemy).\n- **Environment Variables:**\n  - `DATABASE_URL`: Your database connection string (e.g., `postgres://user:password@host:port/dbname`).\n  - `SECRET_KEY`: A long, random string for JWT authentication.\n  - `CRON_SECRET`: (Optional) A secret key to protect the scraping cron endpoint.\n- **Vercel Setup:**\n  - Connect your repository to Vercel.\n  - Configure the environment variables in the Vercel dashboard.\n  - The application will automatically run migrations on startup.\n\n---\n\n## Installation (for End-Users)\n\nThis application is designed to be easy to run on your personal computer. No technical knowledge of Python or Docker is required.\n\n### 1. Download the Latest Release\n\nGo to the [**Releases Page**](https://github.com/D221/vocaloid-rate/releases/latest) on GitHub.\n\n- For **Windows**, download the `vocaloid-rate-windows.zip` file.\n- For **macOS**, download the `vocaloid-rate-macos.zip` file.\n- For **Linux**, download the `vocaloid-rate-linux.zip` file.\n\n### 2. Extract the ZIP File\n\nUnzip the downloaded file to a permanent location on your computer (e.g., your Desktop or a folder in your user directory).\n\n### 3. Run the Application\n\n- **On Windows:** Double-click the **`vocaloid-rate.exe`** file.\n- **On macOS / Linux:** Double-click the **`vocaloid-rate`** binary file. (On first run, you may need to right-click and choose \"Open\" to bypass security warnings).\n\nA terminal window will open, and after a moment, your default web browser will automatically open to `http://localhost:8000`. The application is now running.\n\n### 4. Stop the Application\n\nTo stop the server, simply close the terminal window that opened in the previous step.\n\n## Advanced Installation (Docker)\n\nFor users familiar with Docker, you can run the application using the pre-built image from the GitHub Container Registry.\n\n### 1. Create `docker-compose.yml`\n\n```yaml\nservices:\n  web:\n    image: ghcr.io/d221/vocaloid-rate:latest\n    ports:\n      - \"8000:8000\"\n    volumes:\n      - ./data:/app/data\n    restart: unless-stopped\n```\n\n### 2. Run the Container\n\n```bash\ndocker compose up -d\n```\n\n### 3. Access the Application:\n\n- The application will be available at `http://localhost:8000`.\n  \u003e **Important:** You must use `localhost` and not the IP address `127.0.0.1`. Using the IP address will cause the YouTube video embeds to fail due to API security policies.\n\n### 4. How to Stop:\n\n```bash\ndocker compose down\n```\n\n## Development Setup\n\nThis project uses a Python/FastAPI backend and a JavaScript frontend with a full build system. To contribute or modify the code, you will need both Python and a Node.js-compatible runtime like Node.js or Bun.\n\n### Prerequisites\n\n- **Python 3.8+** and **uv**.\n- **Node.js \u0026 npm** or **Bun**.\n\n### 1. Clone the Repository\n\n```bash\ngit clone https://github.com/D221/vocaloid-rate\ncd vocaloid-rate\n```\n\n### 2. Install Dependencies\n\nFirst, create a Python virtual environment and install the required packages.\n\n```bash\n# Install uv (macOS/Linux)\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n\n# Install uv (Windows)\npowershell -ExecutionPolicy ByPass -c \"irm https://astral.sh/uv/install.ps1 | iex\"\n\n# Install Python packages\nuv sync\n```\n\nNext, install the Node.js development dependencies. This will also set up the pre-commit hooks via Husky.\n\n```bash\n# Using Bun (recommended)\nbun install\n\n# Or using npm\nnpm install\n```\n\n### 3. Running the Development Environment\n\nThe development environment requires three processes to run concurrently: the FastAPI server, the Tailwind CSS compiler, and the JavaScript minifier. The project is configured to handle all of this with a single command.\n\nOpen your terminal and run:\n\n```bash\n# Standard dev mode (uses environment variables)\nbun run dev\n\n# Or force local SQLite mode (ignores DATABASE_URL)\nbun run dev:local\n```\n\nThis command uses `concurrently` to:\n\n1.  Start the FastAPI backend server with **hot-reloading**.\n2.  Start the Tailwind compiler in **watch mode**, which automatically builds and minifies `app.css` on any change.\n3.  Start a file watcher (`chokidar`) that automatically runs `terser` to build and minify all `*.min.js` files whenever you save a source `.js` file.\n\nOnce running, access the application at `http://localhost:8000`. You can now edit your source `.py`, `.js`, and `input.css` files, and all changes will be reflected automatically.\n\n### 4. Code Formatting and Linting\n\nThis project uses Prettier, ESLint, and Ruff to ensure a consistent code style. These are configured to run automatically before each commit using Husky and `lint-staged`.\n\nYou can also run them manually:\n\n- **Format all files:** `bun run format`\n- **Check for linting errors:** `bun run lint`\n- **Attempt to automatically fix linting errors:** `bun run lint:fix`\n\n## Production and Release\n\n### Building for Production\n\nTo create a production-ready build of all static assets (minified CSS and JavaScript), run the following command:\n\n```bash\nbun run build\n```\n\n### Creating a Distributable Release\n\nTo bundle the entire application into a simple, self-contained `.zip` file for end-users who do not have Python or Node.js installed, run the release script:\n\n```bash\nbun run release\n```\n\nThis fully automated process will:\n\n1.  Run the `build` command to generate production assets.\n2.  Use `PyInstaller` to bundle the FastAPI application and a Python interpreter into a single executable.\n3.  Clean up unnecessary source files (like `input.css` and non-minified `.js` files) from the final package.\n4.  Create a `vocaloid-rate-release.zip` file in dist directory, containing the executable and all necessary files for an end-user to run the application.\n\n## APIs Used\n\nThis project integrates with several external APIs to provide its features.\n\n- **[Vocaloard](https://vocaloard.injpok.tokyo/en/):** The primary source of song data. The application scrapes the Top 300 rankings directly from this site.\n\n- **[VocaDB](https://vocadb.net/):** Used to fetch lyrics for the songs. The application makes API calls to VocaDB to retrieve lyrics based on the song title and artist.\n\n- **[YouTube](https://www.youtube.com/):** Used for the embedded video player. The application embeds the YouTube player to stream the music videos for the songs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fd221%2Fvocaloid-rate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fd221%2Fvocaloid-rate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fd221%2Fvocaloid-rate/lists"}