Skip to content

Commit 0c3220e

Browse files
committed
Update GARSS Studio docs
1 parent 40a5658 commit 0c3220e

11 files changed

Lines changed: 83 additions & 10 deletions

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,7 @@ local_secret.json
33
.DS_Store
44
./README.md
55
garss-studio/.playwright-cli
6-
.playwright-cli
6+
.playwright-cli
7+
__pycache__/
8+
*.pyc
9+
garss-studio/.tmp-chrome-mcp-client.mjs

AGENTS.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,49 @@
1616
- `EditREADME.md` 是规范化的数据源,不要用大模型人工提取替代脚本解析
1717
- 如果要同步 `EditREADME.md`,优先使用 `garss-studio/scripts/sync-editreadme.mjs`
1818

19+
## garss-studio 启动方式
20+
21+
开发环境:
22+
23+
```bash
24+
cd garss-studio
25+
cp .env.example .env
26+
docker compose -f docker-compose.dev.yml up --build
27+
```
28+
29+
开发环境默认只暴露单端口入口:
30+
31+
```text
32+
http://127.0.0.1:25173/reader?pw=banana
33+
```
34+
35+
开发 compose 默认 `SCHEDULER_ENABLED=false`,避免启动时自动全量拉取;如需验证自动调度:
36+
37+
```bash
38+
SCHEDULER_ENABLED=true docker compose -f docker-compose.dev.yml up --build
39+
```
40+
41+
生产环境:
42+
43+
```bash
44+
cd garss-studio
45+
cp .env.example .env
46+
docker compose up --build -d
47+
```
48+
49+
生产环境入口同样是:
50+
51+
```text
52+
http://127.0.0.1:25173/reader?pw=banana
53+
```
54+
55+
停止命令:
56+
57+
```bash
58+
docker compose -f docker-compose.dev.yml down
59+
docker compose down
60+
```
61+
1962
## 文档分工
2063

2164
- `PROJECT_MEMORY.md`:记录长期产品决策和上下文
438 KB
Loading
374 KB
Loading
205 KB
Loading
283 KB
Loading
380 KB
Loading
453 KB
Loading

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,39 @@
99
这个名为**嘎!RSS**的项目会利用免费的Github Actions服务, 提供一个内容全面的信息流, 让现代人的知识体系更广泛, 减弱信息茧房对现代人的影响, 让**非茧房信息流**造福人类~
1010
[《嘎!RSS》永久开源页面: https://github.com/zhaoolee/garss](https://github.com/zhaoolee/garss)
1111

12-
## 推荐使用什么软件订阅RSS?
12+
## 舒适阅读的锤子便签风格客户端(2026年5月3日更新)
13+
14+
### 1. 锤子便签风格,舒适阅读
15+
16+
![](./README.assets/623b13c62366ee504501de1cc7498c178fb4dfc6ff6e568fee6b55a155fe810e.png)
17+
18+
### 2. 支持畅享模式与传统模式切换
19+
20+
![](./README.assets/e004241d9ad9d7887c91e846c242471287271b390f5f631e8a78fc118e2f96b3.png)
21+
22+
### 3. 轻量化管理,控制订阅源是否启用
23+
24+
![](./README.assets/f6a63aed0cc760717e05172d003598328c02bb614e72ff53f2babeb0bf52d17c.png)
25+
26+
### 4. 集成RSSHub,用社区的力量获取更多数据源
27+
28+
29+
![](./README.assets/608c2736217add927e9f47109d049a021914ec9ca3b5e17f4e2d7886e5ccb313.png)
30+
31+
32+
### 5. Docker自动化定时可视化拉取
33+
34+
![](./README.assets/90d74483dd047f4d64bb5a8837a4e24b256ead1d8128adb5f0408166594c02fb.png)
35+
36+
```bash
37+
cd garss-studio
38+
cp .env.example .env
39+
docker compose up --build -d
40+
```
41+
访问 [http://127.0.0.1:25173/reader?pw=banana](http://127.0.0.1:25173/reader?pw=banana) 即可
42+
43+
44+
## 小白使用什么软件订阅RSS?
1345
我推荐一款免费的浏览器扩展程序Feedbro ,使用教程[Chrome插件英雄榜第96期《Feedbro》在Chrome中订阅RSS信息流](https://www.v2fy.com/p/096-feedbro-2021-02-27/)
1446

1547
## 主要功能

garss-studio/.env.example

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
ACCESS_CODE=banana
22
ACCESS_TOKEN_SECRET=replace-this-secret
33
SESSION_TTL_HOURS=168
4-
PORT=3001
5-
HOST=0.0.0.0
6-
APP_ROOT=/app
7-
RSSHUB_BASE_URL=http://rsshub:1200
84
SCHEDULER_ENABLED=true
9-
VITE_API_PROXY_TARGET=http://backend:3001

0 commit comments

Comments
 (0)