{"id":31238979,"url":"https://github.com/enderahmetyurt/bloudme","last_synced_at":"2025-11-11T18:22:10.628Z","repository":{"id":315627608,"uuid":"905901877","full_name":"enderahmetyurt/bloudme","owner":"enderahmetyurt","description":"A Minimal RSS Reader","archived":false,"fork":false,"pushed_at":"2025-09-19T16:58:24.000Z","size":829,"stargazers_count":3,"open_issues_count":13,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-19T18:49:23.562Z","etag":null,"topics":["hotwire","hotwire-stimulus","hotwire-turbo","psql","rss-reader","ruby","rubyonrails"],"latest_commit_sha":null,"homepage":"https://bloud.me","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/enderahmetyurt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","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":"2024-12-19T18:48:58.000Z","updated_at":"2025-09-19T16:39:23.000Z","dependencies_parsed_at":"2025-09-19T18:49:48.774Z","dependency_job_id":"1f9ccffc-58ec-4699-88a8-3b22d784572e","html_url":"https://github.com/enderahmetyurt/bloudme","commit_stats":null,"previous_names":["enderahmetyurt/bloudme"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/enderahmetyurt/bloudme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enderahmetyurt%2Fbloudme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enderahmetyurt%2Fbloudme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enderahmetyurt%2Fbloudme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enderahmetyurt%2Fbloudme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/enderahmetyurt","download_url":"https://codeload.github.com/enderahmetyurt/bloudme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enderahmetyurt%2Fbloudme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276459676,"owners_count":25646404,"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-09-22T02:00:08.972Z","response_time":79,"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":["hotwire","hotwire-stimulus","hotwire-turbo","psql","rss-reader","ruby","rubyonrails"],"created_at":"2025-09-22T19:23:20.091Z","updated_at":"2025-11-11T18:22:10.621Z","avatar_url":"https://github.com/enderahmetyurt.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bloudme\n\nFollow your favourite web sites, and read in minimal design.\n\nA modern RSS feed reader built with Ruby on Rails, designed for a clean and distraction-free reading experience.\n\n## ✨ Features\n\n- 📖 Clean, minimal reading interface\n- 🔄 Automatic feed updates via background jobs\n- 🔖 Bookmark articles for later reading\n- 🎨 Modern, responsive design with Tailwind CSS\n- ⚡ Fast, SPA-like experience with Hotwire/Turbo\n- 👤 User authentication and personalized feeds\n- 📧 Email confirmations and notifications\n- 💳 Subscription management with LemonSqueezy integration\n\n## 🚀 Tech Stack\n\n- **Backend**: Ruby on Rails (Edge)\n- **Frontend**: Hotwire/Turbo, Stimulus, Tailwind CSS\n- **Database**: PostgreSQL\n- **Background Jobs**: Solid Queue\n- **Caching**: Solid Cache\n- **Real-time**: Solid Cable\n- **Testing**: MiniTest\n- **Deployment**: Render.com\n- **Monitoring**: Sentry\n\n## 📋 Prerequisites\n\n- Ruby 3.2+\n- Node.js 18+\n- PostgreSQL 14+\n\n## 🛠️ Installation\n\n1. **Clone the repository**\n   ```bash\n   git clone https://github.com/enderahmetyurt/bloudme.git\n   cd bloudme\n   ```\n\n2. **Install dependencies**\n   ```bash\n   bundle install\n   npm install\n   ```\n\n3. **Setup credentials**\n   ```bash\n   # This project uses Rails encrypted credentials instead of .env files\n   # The .env.example file is provided for reference only\n   # Configure your credentials using:\n   rails credentials:edit --environment=development\n   ```\n\n4. **Setup database**\n   ```bash\n   rails db:create\n   rails db:migrate\n   rails db:seed # See user password\n   ```\n\n5. **Build assets**\n   ```bash\n   rails assets:precompile\n   ```\n\n6. **Start the development server**\n   ```bash\n   bin/dev\n   ```\n\nVisit `http://localhost:3000` in your browser.\n\n## 🔧 Development\n\n### Running tests\n```bash\nrails test\nrails test:system\n```\n\n### Code quality\n```bash\nbundle exec rubocop\nbundle exec brakeman\n```\n\n### Background jobs\nBackground jobs are handled by Solid Queue. In development, they run automatically.\n\n### Adding feeds\nFeeds can be added through the web interface or programmatically:\n\n```ruby\nfeed = Feed.create!(\n  name: \"Example Blog\",\n  feed_url: \"https://example.com/feed.xml\",\n  user: current_user\n)\n```\n\n## 📡 API\n\n### Authentication\nThe application uses session-based authentication. API endpoints require a valid session.\n\n### Endpoints\n\n- `GET /feeds` - List user's feeds\n- `POST /feeds` - Create a new feed\n- `GET /articles` - List articles from subscribed feeds\n- `POST /bookmarks` - Bookmark an article\n- `DELETE /bookmarks/:id` - Remove bookmark\n\n## 🐳 Docker Development\n\n```bash\ndocker-compose up -d\n```\n\n## 🚀 Production Deployment\n\nThe application is deployed on Render.com with automatic deployments from the main branch.\n\n## 🔐 Configuration\n\nThis project uses **Rails encrypted credentials** instead of `.env` files for better security. The `.env.example` file is provided only as a reference for the configuration keys needed.\n\n### Managing Credentials\n\n```bash\n# Edit development credentials\nrails credentials:edit --environment=development\n```\n\n### Required Configuration Keys\n\nSee `.env.example` for reference. Your encrypted credentials should include:\n\n- `database_url` - PostgreSQL connection string\n- `sentry_dsn` - Error tracking (optional)\n- `resend_api_key` - Email service (optional)\n- `lemonsqueezy_api_key` - Payment processing (optional)\n- `lemonsqueezy_store_id` - LemonSqueezy store ID (optional)\n- `lemonsqueezy_variant_id` - LemonSqueezy variant ID (optional)\n- `secret_key_base` - Rails secret key\n\n### Why Credentials Instead of .env?\n\n- **Security**: Credentials are encrypted and committed to the repository\n- **Environment-specific**: Different credentials for development, test, and production\n- **Team collaboration**: Secure sharing of configuration across team members\n- **Deployment**: No need to manage separate environment variable files\n\n## 🤝 Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.\n\n## 📝 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🛡️ Security\n\nIf you discover a security vulnerability, please see [SECURITY.md](SECURITY.md) for reporting instructions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenderahmetyurt%2Fbloudme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenderahmetyurt%2Fbloudme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenderahmetyurt%2Fbloudme/lists"}