[!NOTE]
This is a demo version currently supporting Chinese only. A full-featured version with better customization and English content support will be released later.
Elegant reading of real-time and hottest news
Features
Clean and elegant UI design for optimal reading experience
Real-time updates on trending news
GitHub OAuth login with data synchronization
30-minute default cache duration (logged-in users can force refresh)
Adaptive scraping interval (minimum 2 minutes) based on source update frequency to optimize resource usage and prevent IP bans
Set callback URL to: https://your-domain.com/api/oauth/github (replace your-domain with your actual domain)
Obtain Client ID and Client Secret
Environment Variables
Refer to example.env.server. For local development, rename it to .env.server and configure:
# Github Client ID
G_CLIENT_ID=
# Github Client Secret
G_CLIENT_SECRET=
# JWT Secret, usually the same as Client Secret
JWT_SECRET=
# Initialize database, must be set to true on first run, can be turned off afterward
INIT_TABLE=true
# Whether to enable cache
ENABLE_CACHE=true
English | 简体中文 | 日本語
Elegant reading of real-time and hottest news
Features
You can change the
BASE_URLto your own domain.Deployment
Basic Deployment
For deployments without login and caching:
Cloudflare Page Configuration
pnpm run builddist/output/publicGitHub OAuth Setup
https://your-domain.com/api/oauth/github(replaceyour-domainwith your actual domain)Environment Variables
Refer to
example.env.server. For local development, rename it to.env.serverand configure:Database Support
Supported database connectors: https://db0.unjs.io/connectors Cloudflare D1 Database is recommended.
Docker Deployment
In project root directory:
You can also set Environment Variables in
docker-compose.yml.Development
Adding Data Sources
Refer to
shared/sourcesandserver/sourcesdirectories. The project provides complete type definitions and a clean architecture.For detailed instructions on how to add new sources, see CONTRIBUTING.md.
Roadmap
release when ready
Contributing
Contributions are welcome! Feel free to submit pull requests or create issues for feature requests and bug reports.
See CONTRIBUTING.md for detailed guidelines on how to contribute, especially for adding new data sources.
License
MIT © ourongxing