{"id":25416669,"url":"https://github.com/tariqs26/rss-aggregator","last_synced_at":"2026-05-18T05:47:31.342Z","repository":{"id":251821622,"uuid":"838549264","full_name":"tariqs26/rss-aggregator","owner":"tariqs26","description":"RSS Aggregator API written in Go using the Chi router","archived":false,"fork":false,"pushed_at":"2024-12-31T05:08:14.000Z","size":38,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-16T16:58:38.540Z","etag":null,"topics":["go","go-chi","goose","postgresql","sqlc"],"latest_commit_sha":null,"homepage":"","language":"Go","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/tariqs26.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}},"created_at":"2024-08-05T21:53:53.000Z","updated_at":"2024-12-31T05:08:17.000Z","dependencies_parsed_at":"2024-12-31T05:22:02.686Z","dependency_job_id":"a596b133-d4f5-4245-9940-f2257f4750ba","html_url":"https://github.com/tariqs26/rss-aggregator","commit_stats":null,"previous_names":["tariqs26/rss-aggregator"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tariqs26%2Frss-aggregator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tariqs26%2Frss-aggregator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tariqs26%2Frss-aggregator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tariqs26%2Frss-aggregator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tariqs26","download_url":"https://codeload.github.com/tariqs26/rss-aggregator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251347321,"owners_count":21575058,"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","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":["go","go-chi","goose","postgresql","sqlc"],"created_at":"2025-02-16T16:56:06.141Z","updated_at":"2025-10-28T21:15:04.616Z","avatar_url":"https://github.com/tariqs26.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RSS Aggregator\n\nA simple RSS feed aggregator that allows users to:\n\n- Add RSS feeds to be collected.\n- Follow and un-follow RSS feeds that they have added.\n- Fetch the latest posts from the RSS feeds they follow.\n\n## API Routes\n\n### General\n\n- `GET /v1/ping`: health check endpoint.\n\n### Users\n\n- `POST /v1/users`: create a new user.\n  - request body:\n    ```json\n    { \"name\": \"string\" }\n    ```\n- `GET /v1/users` (requires authentication): get current user details.\n- `DELETE /v1/users` (requires authentication): delete current user.\n- `GET /v1/users/posts` (requires authentication): get posts from the feeds the current user follows.\n\n### Feeds\n\n- `POST /v1/feeds`: add a new feed.\n  - request body:\n    ```json\n    {\n      \"name\": \"string\",\n      \"url\": \"string\"\n    }\n    ```\n- `GET /v1/feeds` (requires authentication): get all feeds.\n- `DELETE /v1/feeds/{id}` (requires authentication): delete a feed by ID.\n- `POST /v1/feeds/{id}/follow` (requires authentication): follow a feed by ID.\n\n### Feed Follows\n\n- `GET /v1/feed-follows` (requires authentication): get all followed feeds.\n- `DELETE /v1/feed-follows/{id}` (requires authentication): unfollow a feed by ID.\n\n## Setup and Installation\n\n### Prerequisites\n\n- [Go](https://golang.org/doc/install) 1.22.3 or later\n- [PostgreSQL](https://www.postgresql.org/download/) 16.0 or later\n\n### Clone the Repository\n\n```bash\ngit clone https://github.com/tariqs26/rss-aggregator.git\ncd rss-aggregator\n```\n\n### Install Dependencies\n\nThis project uses the following Go packages:\n\n```bash\ngo get github.com/joho/godotenv@v1.5.1\ngo get github.com/go-chi/chi/v5@v5.0.12\ngo get github.com/google/uuid@v1.6.0\ngo get github.com/lib/pq@v1.10.9\ngo get github.com/rs/cors@v1.11.0\n```\n\n### Additional Tools\n\n- [sqlc](https://github.com/sqlc-dev/sqlc) for generating type-safe code from SQL.\n\n  ```bash\n  go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest\n  ```\n\n- [goose](https://github.com/pressly/goose) for database migrations.\n\n  ```bash\n  go install github.com/pressly/goose/v3/cmd/goose@latest\n  ```\n\n### Environment Variables\n\nCreate a `.env` file in the root directory of your project and add the following environment variables:\n\n```bash\nPORT=8080\nDATABASE_URL=postgres://username:password@localhost:5432/yourdbname?sslmode=disable\n```\n\nReplace `username`, `password`, `localhost:5432`, and `yourdbname` with your PostgreSQL credentials and database details.\n\n## Usage\n\n### Apply Migrations\n\nNavigate to the directory containing the migration files and run goose to apply the migrations:\n\n```bash\ncd sql/schema\ngoose -dir . postgres \"postgres://username:password@localhost:5432/yourdbname?sslmode=disable\" up\n```\n\n### Generate SQLC Code\n\nGenerate the SQLC code for interacting with the database:\n\n```bash\nsqlc generate\n```\n\n### Build and Run the Server\n\nCompile the server and run it:\n\n```bash\ngo build -o rss-aggregator\n./rss-aggregator\n```\n\nThe server will start on the port specified in the `.env` file (default is `8080`).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftariqs26%2Frss-aggregator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftariqs26%2Frss-aggregator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftariqs26%2Frss-aggregator/lists"}