|
1 | 1 | # Awesome Stargazer - GitHub Pages Site |
2 | 2 |
|
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. |
4 | 4 |
|
5 | 5 | ## Features |
6 | 6 |
|
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/`. |
18 | 27 |
|
19 | 28 | ## Local Development |
20 | 29 |
|
21 | | -To run locally: |
| 30 | +```bash |
| 31 | +cd docs |
| 32 | +python3 -m http.server 8000 |
| 33 | +# Visit http://localhost:8000 |
| 34 | +``` |
22 | 35 |
|
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 |
26 | 37 |
|
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 |
28 | 44 |
|
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. |
35 | 46 |
|
36 | | -## Technologies Used |
| 47 | +## Keyboard Shortcuts |
37 | 48 |
|
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 |
43 | 54 |
|
44 | | -## Data Source |
| 55 | +## Browser Compatibility |
45 | 56 |
|
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