code.pablomurad.com

Private-Trackers-Spreadsheet

Sortable, searchable table of private BitTorrent tracker stats

README.md raw 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
<div align="center">
<h1>🏴‍☠️ Private Trackers Spreadsheet</h1>

[![Live Site](https://img.shields.io/badge/🌐_Live_Site-hdvinnie.github.io-e74c3c?style=for-the-badge)](https://hdvinnie.github.io/Private-Trackers-Spreadsheet/)
[![GitHub Stars](https://img.shields.io/github/stars/hdvinnie/Private-Trackers-Spreadsheet?style=for-the-badge&color=ffd700)](https://github.com/hdvinnie/Private-Trackers-Spreadsheet/stargazers)
[![GitHub Forks](https://img.shields.io/github/forks/hdvinnie/Private-Trackers-Spreadsheet?style=for-the-badge&color=3498db)](https://github.com/hdvinnie/Private-Trackers-Spreadsheet/network)

*"A interactive database of private BitTorrent tracker statistics with sorting and filtering capabilities. Built using AlpineJS, HTML5 and CSS3"*

</div>

---

## 📖 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](https://hdvinnie.github.io/Private-Trackers-Spreadsheet/) to start exploring tracker data immediately.

### 💻 **Local Development**

```bash
# 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**

```bash
bun run update:jackett
```

> Recommended: Increase GitHub API rate limits when running `npm run update:jackett`, set an access token:
>
> macOS/Linux
> ```bash
> 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
   ```

2. **🌿 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
   ```

---

<div align="center">

**Made with ❤️ by the private tracker community**

*If you find this project useful, please consider giving it a ⭐ star on GitHub!*

</div>