Skip to content
This repository was archived by the owner on Aug 8, 2025. It is now read-only.

Commit 215ed31

Browse files
authored
[chores]: updated readme w appropriate details;
1 parent 54d0389 commit 215ed31

File tree

1 file changed

+62
-28
lines changed

1 file changed

+62
-28
lines changed

README.md

Lines changed: 62 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,65 @@
1-
# Deployment ready (React + TS + Vite + Tailwind)
1+
# 📚 r/LocalLLaMA Archive
22

3-
GitHub page should be available here: https://maifeeulasad.github.io/LocalLLaMA
3+
**A free, open, automatically-updating snapshot of r/LocalLLaMA — keeping community discussions, insights, and model links accessible, even if the original subreddit ever disappears.**
44

5-
## Using docker
5+
---
6+
7+
## ✨ What is this?
8+
9+
This is a **static archive** of [r/LocalLLaMA](https://www.reddit.com/r/LocalLLaMA) — automatically scraping **new posts** every hour and saving them as JSON and simple static pages.
10+
11+
It’s built with:
12+
- **React + Ant Design** (for clean browsing)
13+
- **Node.js scrapers** (fetch & dump posts)
14+
- **Static hosting via GitHub Pages**
15+
16+
🔗 **Live Archive**: [Visit here](https://maifeeulasad.github.io/LocalLLaMA/)
17+
📂 **Repo**: [View source](https://github.com/maifeeulasad/LocalLLaMA)
18+
19+
---
20+
21+
## 🔒 Why?
22+
23+
- Subreddits get banned, private, or wiped all the time.
24+
- We don’t want thousands of hours of community knowledge — local LLM experiments, model links, guides — to vanish.
25+
- By saving it as static files, it’s **easy to fork, mirror, or self-host**.
26+
27+
---
28+
29+
## ⚡ Features
30+
31+
- ✅ Hourly scraping of `hot`, `top`, and `best` posts
32+
- ✅ Each post saved as JSON for transparency
33+
- ✅ Clean static pages for browsing
34+
- ✅ Built for **forking** — anyone can mirror this easily
35+
-**No user tracking**, no ads
36+
37+
---
38+
39+
## 🧩 How it works
40+
41+
1. **Scraper:** Runs on GitHub Actions every hour.
42+
2. **Builder:** Regenerates the static site pages automatically.
43+
3. **Deploy:** Pushes to GitHub Pages.
44+
4. **Browse:** You can read, search, and explore right in your browser.
45+
46+
---
47+
48+
## 🔍 Search
49+
50+
This site includes a **fuzzy search bar** (powered by Fuse.js) so you can quickly find posts by keywords — even across thousands of JSON files.
51+
52+
---
53+
54+
## 🌍 Fork, Mirror & Contribute
55+
56+
This is **not meant to be the only copy**.
57+
The real value is when **many people fork and mirror it**!
58+
59+
**How to mirror:**
660
```bash
7-
docker compose up
8-
```
9-
10-
## Steps to reproduce:
11-
- Get `ssh-keygen`
12-
- Run this command `ssh-keygen -t rsa -b 4096`
13-
- Save it to a nice place
14-
- Give it some cool and understandable name(mainly for later usage - I had key pair named *okjanu* from 2018, I have no idea what do they do, but it's under folder `imporatnt`)
15-
- Backup to some cloud store and remove it from local storage
16-
- Go to *secrets* under *settings*
17-
- For this repo, I went to: https://github.com/maifeeulasad/LocalLLaMA/settings/secrets/actions
18-
- Open the private key, *file without `.pub` extension*, with any text editor or in terminal
19-
- Paste it write there
20-
- Go to *deploy keys* under *settings*
21-
- For this repo: https://github.com/maifeeulasad/LocalLLaMA/settings/keys
22-
- Open the public key and paste there
23-
- Give it write access(must)
24-
25-
## Some stuff:
26-
- GA included, please change it accordingly, at the very bottom of `index.html`. Here: https://github.com/maifeeulasad/LocalLLaMA/blob/80773182fae66e463d7928f690863bc965757a38/index.html#L35
27-
- In `App.tsx`, find `<BrowserRouter ...>` and set the project name here, correctly. Currently set to:
28-
```
29-
<BrowserRouter basename="/LocalLLaMA">
30-
...
31-
```
61+
git clone https://github.com/maifeeulasad/LocalLLaMA.git
62+
# Keep your fork in sync
63+
pnpm install
64+
pnpm run build
65+
# Deploy to your own GitHub Pages, server, or static hosting

0 commit comments

Comments
 (0)