Skip to content

Commit 04c6732

Browse files
jungleAI404jungleAI404
committed
add readme
1 parent b233a60 commit 04c6732

6 files changed

Lines changed: 100 additions & 18 deletions

File tree

‎README.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# 🌟 StarScope / 星探
2+
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
4+
[![GitHub Pages](https://img.shields.io/badge/Deployed%20on-GitHub%20Pages-89216B.svg)](https://jungleAI404.github.io/github-daily-star/)
5+
6+
> **中文名**：星探
7+
> **English Name**：StarScope
8+
> 一份由开发者**人工精心挑选**的 GitHub 高增长项目推荐列表，每日更新，极简呈现。
9+
10+
🌐 **在线访问**：[https://githubStar.xjmunity.com](https://githubStar.xjmunity.com)
11+
12+
---
13+
14+
## 📖 项目简介
15+
16+
在 GitHub 每日成千上万的项目中，真正值得关注的“新星”往往转瞬即逝。算法推荐可能错过小众但惊艳的项目，而人工筛选才能捕捉到那些**真正有趣、有潜力、有故事**的开源之作。
17+
18+
**StarScope**（星探）正是这样一个**人工精选项目发现平台**。
19+
由我（一名热爱发掘开源项目的开发者）每日亲自浏览、筛选、整理 GitHub 上**新增 star 数最多、增长最快、最具话题性**的项目，并以**极简、优雅、可归档**的方式呈现。
20+
21+
- 🔍 **人工精选**：拒绝算法，坚持人工阅读与判断。
22+
- 📅 **每日更新**：每天一份“开源晚报”，不错过任何亮点。
23+
- 🌐 **中英文双语**：内容双语呈现，界面自动跳转。
24+
- 🗂️ **完整归档**：支持按日、按月回溯历史推荐。
25+
- 🎨 **极简设计**：专注内容，无广告、无追踪、无干扰。
26+
27+
> 这不是一个数据聚合工具，而是一份**写给开发者的开源日报**。
28+
29+
---
30+
31+
## 🎯 核心特性
32+
33+
- ✅ **人工精选**：每一条数据都经过人工阅读、筛选与润色，确保质量与可读性。
34+
- 🌐 **双语支持**：所有页面支持中文与英文，通过 `root_index.html` 自动跳转。
35+
- 📅 **时间线归档**：提供完整的“历史归档”页面，支持按月浏览每日推荐。
36+
- 🌙 **暗色模式**：支持暗色/亮色主题切换，偏好保存至本地。
37+
- 🧱 **纯静态部署**：使用 GitHub Pages 部署，零服务器成本，极致轻量。
38+
- 🔓 **完全开源**：所有代码、模板、数据均公开，欢迎贡献与复用。
39+
40+
---
41+
42+
## 🖼️ 截图预览
43+
44+
### 首页（今日推荐）
45+
![首页截图](https://via.placeholder.com/800x400?text=Home+Page+Preview)
46+
*展示当日精选项目，突出 star 增长、项目语言与“新项目”标签*
47+
48+
### 历史归档
49+
![归档截图](https://via.placeholder.com/800x400?text=Archive+Page+Preview)
50+
*按月组织的时间线，清晰展示每日推荐数量*
51+
52+
### 关于页面
53+
![关于截图](https://via.placeholder.com/800x400?text=About+Page+Preview)
54+
*阐述项目理念与人工筛选的价值*
55+
56+
> 💡 请将 `https://via.placeholder.com/...` 替换为你实际的截图链接。
57+
58+
---
59+
60+
## 🛠️ 技术架构
61+
62+
本项目采用 **“人工输入 + 静态生成”** 的模式，技术栈简洁透明：
63+
64+
| 层级 | 技术 |
65+
|------|------|
66+
| **前端** | HTML5, CSS3, JavaScript (Vanilla) |
67+
| **模板引擎** | [Jinja2](https://jinja.palletsprojects.com/)（Python） |
68+
| **构建脚本** | `build.py`（Python） |
69+
| **样式设计** | 原生 CSS + `:root` 变量 + 响应式布局 |
70+
| **多语言支持** | JSON 翻译文件 + 模板变量注入 |
71+
| **部署方式** | GitHub Pages（`gh-pages` 分支或 `docs/` 目录） |
72+
| **SEO 优化** | `sitemap.xml`、`og:` 标签、`hreflang` 多语言支持 |
73+
74+
### 项目结构说明
75+
76+
```bash
77+
star-scope/
78+
├── build.py # 静态站点生成脚本（使用 Jinja2）
79+
├── data/ # 人工整理的每日项目数据
80+
│ ├── en/ # 英文版数据（JSON）
81+
│ └── zh/ # 中文版数据（JSON）
82+
├── templates/ # HTML 模板（Jinja2）
83+
├── static/ # 静态资源（CSS, JS）
84+
├── translations/ # 多语言文案翻译（site_name, nav, etc.）
85+
├── output/ # 构建输出目录（部署内容）
86+
└── README.md

‎build.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
# --- 配置 ---
1010
LANGUAGES = ['en', 'zh']
1111
DEFAULT_LANGUAGE = 'en'
12-
BASE_URL = "https://jungleAI404.github.io/github-daily-star" # 部署后请修改为你的域名
12+
BASE_URL = "https://githubstars.xjmunity.com/" # 部署后请修改为你的域名
1313

1414
# --- 路径定义 ---
1515
PATH_DATA = 'data'

‎static/css/style.css‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
/* /css/style.css */
2-
31
/* 基础重置和变量 */
42
:root {
53
--primary-color: #10B981; /* 绿色 - Star增长 */

‎static/js/main.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
// /js/main.js
2-
31
document.addEventListener('DOMContentLoaded', function() {
42

53
// --- 暗色模式切换 ---

‎translations/en.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"site_name": "Daily Stars",
2+
"site_name": "StarScope",
33
"nav_home": "Home",
44
"nav_archive": "Archive",
55
"nav_about": "About",
66
"lang_switcher_text": "中文",
77
"dark_mode_label": "Toggle Dark Mode",
8-
"hero_title": "Discover Daily GitHub Stars",
9-
"hero_subtitle": "A curated, auto-updating list of the fastest-growing open-source projects on GitHub.",
8+
"hero_title": "Discover Trending GitHub Projects",
9+
"hero_subtitle": "A curated platform for discovering trending GitHub projects with rapid star growth — helping you stay ahead with the most exciting open-source innovations.",
1010
"previous_day": "Previous Day",
1111
"next_day": "Next Day",
1212
"total_projects": "projects",
@@ -15,7 +15,7 @@
1515
"new_badge": "NEW",
1616
"archive_title": "Archive",
1717

18-
"about_title": "About Daily Stars",
18+
"about_title": "About StarScope",
1919
"about_intro_p1": "Hello! I'm the creator of Daily Stars, a developer passionate about open source and technology. In this era of information overload, I found it challenging to track the truly noteworthy emerging projects on GitHub. Therefore, I created Daily Stars, hoping to help more developers discover valuable new projects.",
2020
"about_philosophy_h2": "Project Philosophy",
2121
"about_philosophy_p1": "The core idea behind Daily Stars is \"Data-Driven Minimalism\". We believe in:",
@@ -30,6 +30,6 @@
3030
"about_tech_li4": "Deployment: Deployed on GitHub Pages via GitHub Actions.",
3131
"about_contact_h2": "Contact Me",
3232
"about_contact_p1": "If you have any suggestions or ideas, feel free to reach out to me:",
33-
"about_contact_li1": "Email: your-email@example.com",
34-
"about_contact_li2": "GitHub: @your-username"
33+
"about_contact_li1": "Email: junglehxj@gmail.com",
34+
"about_contact_li2": "GitHub: https://github.com/jungleAI404/github-daily-star"
3535
}

‎translations/zh.json‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"site_name": "每日之星",
2+
"site_name": "星探",
33
"nav_home": "首页",
44
"nav_archive": "历史归档",
55
"nav_about": "关于",
66
"lang_switcher_text": "English",
77
"dark_mode_label": "切换暗色模式",
8-
"hero_title": "发现每日 GitHub 新星",
9-
"hero_subtitle": "一份精心策划、自动更新的列表，为您展示 GitHub 上增长最快的开源项目。",
8+
"hero_title": "GitHub 热门项目发现",
9+
"hero_subtitle": "一个精选的GitHub明星项目发现平台，每日追踪高星趋势项目，助你快速发现前沿开源技术与有趣创意。",
1010
"previous_day": "前一天",
1111
"next_day": "后一天",
1212
"total_projects": "个项目",
@@ -15,21 +15,21 @@
1515
"new_badge": "新",
1616
"archive_title": "历史归档",
1717

18-
"about_title": "关于“每日之星”",
18+
"about_title": "关于“星探”",
1919
"about_intro_p1": "你好！我是“每日之星”的创建者，一名热爱开源和技术的开发者。在这个信息爆炸的时代，我发现很难跟踪 GitHub 上那些真正值得关注的新兴项目。因此，我创建了“每日之星”，希望能帮助更多开发者发现有价值的新项目。",
2020
"about_philosophy_h2": "项目理念",
2121
"about_philosophy_p1": "“每日之星”的核心理念是“信息驱动的极简主义”。我们相信：",
2222
"about_philosophy_li1": "内容为王：设计完全为数据和内容服务，所有视觉元素旨在增强信息传达的清晰度，而非分散注意力。",
2323
"about_philosophy_li2": "高信噪比：移除所有不必要的装饰，追求功能性的美学。",
2424
"about_philosophy_li3": "数据可视化：通过直观的方式展示项目的增长趋势。",
2525
"about_tech_h2": "技术实现",
26-
"about_tech_p1": "“每日之星”是一个完全静态的网站，采用以下技术栈：",
26+
"about_tech_p1": "“星探”是一个完全静态的网站，采用以下技术栈：",
2727
"about_tech_li1": "前端：HTML5, CSS3, JavaScript (原生)",
2828
"about_tech_li2": "数据获取：通过 GitHub API 自动抓取项目数据。",
2929
"about_tech_li3": "自动化：使用带有 Jinja2 模板的 Python 脚本每日生成站点。",
3030
"about_tech_li4": "部署：通过 GitHub Actions 部署到 GitHub Pages。",
3131
"about_contact_h2": "联系方式",
3232
"about_contact_p1": "如果你有任何建议或想法，欢迎通过以下方式联系我：",
33-
"about_contact_li1": "邮箱：your-email@example.com",
34-
"about_contact_li2": "GitHub: @your-username"
33+
"about_contact_li1": "邮箱：junglehxj@gmail.com",
34+
"about_contact_li2": "GitHub: https://github.com/jungleAI404/github-daily-star"
3535
}

0 commit comments

Comments
 (0)