📖 Overview

This project provides a user-friendly interface to explore and manage private BitTorrent tracker statistics. It allows users to sort, filter, and search through a wide range of trackers, making it easier to find the right one for their needs. The UI is built with AlpineJS, ensuring a lightweight and responsive experience. There is a dark and light mode toggle as well as a accent color switcher, allowing users to customize their viewing experience. The data is stored in a JSON format, making it easy to update and maintain. The data is sourced from user contributions and regularly updated using Jackett, ensuring that the information remains current and relevant.

🏃‍♂️ Quick Start

🌐 View Online

Simply visit the live site to start exploring tracker data immediately.

💻 Local Development

# Install Bun
curl -fsSL https://bun.sh/install | bash

# Clone the repository
git clone https://github.com/hdvinnie/Private-Trackers-Spreadsheet.git

# Navigate to project directory
cd Private-Trackers-Spreadsheet

# Install deps and start dev server
bun install
bun run dev

💻 Update trackers2.json from Jackett

bun run update:jackett

Recommended: Increase GitHub API rate limits when running npm run update:jackett, set an access token:

macOS/Linux

> export GITHUB_TOKEN=ghp_yourtoken
> ```
> Windows (PowerShell)
> ```powershell
> $Env:GITHUB_TOKEN = "ghp_yourtoken"
> ```

---

## 🤖 Automation
- A weekly GitHub Action is used to update trackers2.json from Jackett and commit changes when a diff is present.

---

### 📝 **How to Contribute**

1. **🍴 Fork the Repository**
   ```bash
   # Click the "Fork" button on GitHub or use:
   gh repo fork hdvinnie/Private-Trackers-Spreadsheet

1. 🌿 Create a Feature Branch bash git checkout -b feature/your-amazing-feature 3. ✨ Make Your Changes - Add new tracker data to trackers.json - Improve the UI/UX - Fix bugs or enhance features - Update documentation 4. 🚀 Submit a Pull Request bash git commit -m "add: amazing new feature" git push origin feature/your-amazing-feature