Skip to content

Commit 4a9753a

Browse files
Copilot0xrinegade
andcommitted
Update docs site with complete 19.5K repository data
Co-authored-by: 0xrinegade <[email protected]>
1 parent 03fc0f7 commit 4a9753a

File tree

8 files changed

+139842
-2982
lines changed

8 files changed

+139842
-2982
lines changed

app.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,11 @@ function saveToStorage() {
3333
// Fetch and parse repository data
3434
async function fetchRepoData() {
3535
try {
36-
const response = await fetch('repo-data.json');
36+
const response = await fetch('data.json');
3737
if (response.ok) {
38-
allRepos = await response.json();
38+
const data = await response.json();
39+
// Check if data has repos property or is array
40+
allRepos = Array.isArray(data) ? data : (data.repos || []);
3941
allRepos.forEach(repo => categories.add(repo.category));
4042
console.log(`Loaded ${allRepos.length} repositories from JSON`);
4143
} else {

docs/README.md

Lines changed: 42 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,57 @@
11
# Awesome Stargazer - GitHub Pages Site
22

3-
This is the GitHub Pages site for exploring all repositories in the awesome-stargazer collection.
3+
A dynamic, interactive web application to explore 19,564+ curated GitHub repositories across 567 categories.
44

55
## Features
66

7-
- **Repository Explorer**: Browse 59,300+ categorized repositories
8-
- **Advanced Search**: Search by name, topic, language, or description
9-
- **Dynamic Filters**: Filter by category and sort by various criteria
10-
- **Bookmarks**: Save repositories for later
11-
- **Likes**: Mark your favorite repositories
12-
- **Learning Paths**: Create personalized learning journeys
13-
- **Share**: One-click sharing to Twitter/X
14-
- **Dark/Light Mode**: Toggle between themes
15-
- **Keyboard Shortcuts**: Power-user navigation
16-
- **Mobile Responsive**: Works on all devices
17-
- **PWA Support**: Install as an app
7+
- **📚 Repository Explorer**: Browse all repos with rich metadata
8+
- **🔍 Dynamic Search**: Real-time filtering by name, description, or category
9+
- **🎯 Learning Paths**: Create and manage personalized learning journeys
10+
- **🔖 Bookmarks**: Save favorites with localStorage persistence
11+
- **❤️ Likes & Trending**: Like repos and see what's popular
12+
- **🌓 Dark/Light Mode**: Toggle themes with one click
13+
- **⌨️ Keyboard Shortcuts**: Power-user navigation (⌘K, Esc, T, ?, 1-4)
14+
- **📱 Mobile Responsive**: Works beautifully on all devices
15+
- **🚀 GitHub-like UI**: Familiar design and interactions
16+
17+
## Tech Stack
18+
19+
- Pure HTML/CSS/JavaScript (no frameworks)
20+
- LocalStorage for data persistence
21+
- Pre-generated JSON data (6.2MB)
22+
- ~1,800 lines of code
23+
24+
## Data Generation
25+
26+
Run `python3 generate-repo-data.py` from the root directory to regenerate `docs/data.json` from the markdown files in `categories/`.
1827

1928
## Local Development
2029

21-
To run locally:
30+
```bash
31+
cd docs
32+
python3 -m http.server 8000
33+
# Visit http://localhost:8000
34+
```
2235

23-
1. Clone the repository
24-
2. Serve the `docs` directory with any HTTP server
25-
3. Example: `python3 -m http.server 8000` from the docs directory
36+
## GitHub Pages Deployment
2637

27-
## Keyboard Shortcuts
38+
This site is configured to deploy from the `docs/` directory. Enable GitHub Pages in repository settings:
39+
40+
1. Go to Settings → Pages
41+
2. Select "Deploy from a branch"
42+
3. Choose branch `main` (or your default branch) and folder `/docs`
43+
4. Save
2844

29-
- `⌘/Ctrl + K`: Focus search
30-
- `Esc`: Clear search or close modal
31-
- `?`: Show shortcuts help
32-
- `T`: Toggle theme
33-
- `B`: View bookmarks
34-
- `P`: View learning paths
45+
**Note**: The `data.json` file is 6.2MB. GitHub has a recommended limit of 1MB per file for optimal performance. Consider splitting the data or using pagination if you encounter issues.
3546

36-
## Technologies Used
47+
## Keyboard Shortcuts
3748

38-
- Pure HTML, CSS, and JavaScript (no frameworks)
39-
- GitHub-like UI design
40-
- Local storage for data persistence
41-
- Progressive Web App (PWA) capabilities
42-
- Responsive design for mobile and desktop
49+
- `⌘/Ctrl + K` - Focus search
50+
- `Esc` - Clear search / Close modal
51+
- `T` - Toggle dark/light mode
52+
- `?` - Show help
53+
- `1-4` - Switch between tabs
4354

44-
## Data Source
55+
## Browser Compatibility
4556

46-
Repository data is loaded from the markdown files in the `categories/` directory of the main repository.
57+
Works in all modern browsers (Chrome, Firefox, Safari, Edge).

0 commit comments

Comments
 (0)