{"id":31941794,"url":"https://github.com/bencode/reading","last_synced_at":"2025-10-14T09:21:45.085Z","repository":{"id":309906010,"uuid":"1037100611","full_name":"bencode/reading","owner":"bencode","description":"A Reading System","archived":false,"fork":false,"pushed_at":"2025-10-06T07:27:31.000Z","size":10726,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-06T09:37:13.102Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://in.qijun.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bencode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-13T04:24:16.000Z","updated_at":"2025-10-06T07:27:36.000Z","dependencies_parsed_at":"2025-08-14T14:14:08.212Z","dependency_job_id":"d8044a31-a15e-4994-b036-92076b2d42dd","html_url":"https://github.com/bencode/reading","commit_stats":null,"previous_names":["bencode/reading"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/bencode/reading","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bencode%2Freading","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bencode%2Freading/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bencode%2Freading/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bencode%2Freading/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bencode","download_url":"https://codeload.github.com/bencode/reading/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bencode%2Freading/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279018616,"owners_count":26086404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-14T09:21:43.105Z","updated_at":"2025-10-14T09:21:45.078Z","avatar_url":"https://github.com/bencode.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Reading - AI-Powered Reading System\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n**Reading** is an intelligent reading system that collects, curates, and organizes tech articles into weekly reading collections. Features AI-powered content processing, rich markdown editing, and a clean web interface for focused reading experiences.  \n🌐 **Demo**: [in.qijun.io](https://in.qijun.io) · 📋 [RSS Sources](packages/tasks/rss_config.yaml)\n\n---\n\n## 🌟 Features\n\n### 📰 Smart Article Collection\n- RSS integration \u0026 web scraping from multiple sources\n- AI-powered content classification \u0026 tagging\n- Article notes and skip functionality for better organization\n\n### 📖 Weekly Reading Collections\n- Create curated article collections with custom titles and descriptions\n- Rich markdown editor with AI assistant for content creation\n- Draft/publish workflow with cover images\n- Public reading interface for published collections\n\n### 🤖 AI Processing\n- Automatic article summarization\n- Content filtering by interest and relevance\n- Smart categorization and quality assessment\n- AI-powered image generation for collection covers\n\n### 🛠️ Tech Stack\n- **Frontend**: Next.js 15, TypeScript, Tailwind CSS, Shadcn/ui\n- **Backend**: Python 3.8+, SQLite, RSS parser, LLM APIs\n- **Database**: SQLite with migration system using yoyo-migrations  \n\n---\n\n## 🚀 Quick Start\n\n### Prerequisites\n- Node.js 18+ and pnpm\n- Python 3.8+\n- SQLite\n\n### Installation\n```bash\ngit clone https://github.com/yourusername/reading.git\ncd reading\npnpm install\ncd packages/tasks \u0026\u0026 pip install -r requirements.txt\n```\n\n### Configuration\n1. Copy environment file: `cp .env.example .env`\n2. Configure API keys and database settings in `.env`\n3. Initialize database: `yoyo apply -d sqlite:///data/reading.db packages/tasks/migrations/`\n\n### Development\nStart both services:\n```bash\n# Terminal 1 - Web frontend\ncd packages/web \u0026\u0026 pnpm dev\n\n# Terminal 2 - Article scraping (optional)\ncd packages/tasks \u0026\u0026 python scraper.py\n```\n\nVisit `http://localhost:3000` to access the application.\nAdmin interface: `http://localhost:3000/admin`  \n\n---\n\n## 🔐 Authentication \u0026 Security\n\n### Admin Access Setup\nThe application uses password-based authentication for admin features:\n\n1. Generate password hash:\n   ```bash\n   cd packages/web\n   node generate-hash.js your-admin-password\n   ```\n\n2. Add to `.env.local`:\n   ```env\n   ADMIN_PASSWORD_HASH_ENCODED=\u003cgenerated-hash\u003e\n   ```\n\n3. Access admin via: `http://localhost:3000/auth?token=your-access-token`\n\n### Access Levels\n- **Public**: Browse published collections and articles (read-only)\n- **Authenticated**: Full CRUD access to collections, articles, and admin features  \n\n---\n\n## 🐳 Docker Deployment\n```bash\n./scripts/deploy.sh\n```\n- Web: Next.js frontend  \n- Scraper: scheduled article collection  \n- SQLite with volume persistence  \n\n---\n\n## 💾 Database \u0026 Data Management\n\n### Database Migrations\n```bash\n# Apply all pending migrations\nyoyo apply -d sqlite:///data/reading.db packages/tasks/migrations/\n\n# List migration status\nyoyo list -d sqlite:///data/reading.db packages/tasks/migrations/\n```\n\n### Data Management Scripts\n```bash\n./scripts/data-manager.sh backup   # Backup database\n./scripts/data-manager.sh restore  # Restore from backup\n./scripts/data-manager.sh export   # Export SQL dump\n```\n\n### Article Quality Management\n```bash\n# Run migrations first for new installations\nyoyo apply -d sqlite:///data/reading.db packages/tasks/migrations/\n\n# Preview articles to be removed\n./scripts/clean-database.sh --dry-run\n\n# Clean specific source\n./scripts/clean-database.sh --source \"Hacker News\"\n\n# Test on limited articles\n./scripts/clean-database.sh --limit 50 --dry-run\n\n# Check processing status\n./scripts/clean-database.sh --status\n\n# Execute cleanup (after preview)\n./scripts/clean-database.sh --confirm\n```\n\n---\n\n## 🛠️ Development\n\n### Project Structure\n```\npackages/\n├── web/                 # Next.js frontend\n│   ├── src/app/        # App router pages\n│   ├── src/components/ # Reusable UI components\n│   ├── src/services/   # API service layers\n│   └── src/lib/        # Database and utilities\n└── tasks/              # Python backend\n    ├── migrations/     # Database schema migrations\n    ├── scraper.py     # RSS feed scraper\n    ├── article_filter.py # AI-powered filtering\n    └── llm_processing.py # LLM integration\n```\n\n### Development Commands\n\n**Web Frontend (Next.js)**\n```bash\ncd packages/web\npnpm dev          # Start development server (localhost:3000)\npnpm build        # Build for production\npnpm start        # Start production server\npnpm lint         # Run ESLint\n```\n\n**Python Backend**\n```bash\ncd packages/tasks\npip install -r requirements.txt  # Install dependencies\npython scraper.py                # Run article scraper\nmake lint                        # Run code quality checks\nmake format                      # Format code with black and isort\n```\n\n### Environment Configuration\n- `LLM_API_ENDPOINT` and `LLM_API_KEY` for AI processing\n- `DASHSCOPE_API_KEY` for AI image generation (optional)\n- `ADMIN_PASSWORD_HASH_ENCODED` for authentication\n- Database path: `../../data/reading.db` (relative to project root)  \n\n---\n\n📄 Licensed under [MIT](LICENSE).  \n✨ [Issues \u0026 Feature Requests](https://github.com/yourusername/reading/issues)  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbencode%2Freading","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbencode%2Freading","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbencode%2Freading/lists"}