Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clxrityy/gorssagg
https://github.com/clxrityy/gorssagg
go goose postgresql rss rss-aggregator sql
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/clxrityy/gorssagg
- Owner: clxrityy
- Created: 2024-05-10T23:52:05.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-12T19:34:42.000Z (8 months ago)
- Last Synced: 2024-05-13T20:22:49.320Z (8 months ago)
- Topics: go, goose, postgresql, rss, rss-aggregator, sql
- Language: Go
- Homepage:
- Size: 139 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gorssagg
Go RSS feed aggregator authenticated with API keys
---
```zsh
git clone https://github.com/clxrityy/gorssagg.git
```
```zsh
go mod vendor && go mod tidy
```
```zsh
go build && ./gorssagg
```
## Requirements
- **PostgreSQL** server & client (view [here](/sql/README.md) for the guide)
- [`sqlc`](https://sqlc.dev/)
- [`goose`](https://github.com/c9s/goose)
---
## [`.env`](/.env.example)
```.env
PORT=8080
DB_URL=postgres://postgres:@localhost:5432/gorssagg?sslmode=disable
```
---
## Routes
- `/v1` - base route
```go
import (
//...
"github.com/go-chi/chi"
"github.com/go-chi/cors"
//...
)
//...
func main() {
//...
router := chi.NewRouter();
router.Use(cors.Handler(cors.Options{
//...
}))
v1Router := chi.NewRouter();
router.Mount("v1", v1Router);
}
```
- ##### `/v1/healthz` - test route (responds with `200` if working)
- ##### `/v1/error` - error route (responds with `400`)
- ##### `/v1/users` - users route
- **POST** - creates a user, takes a `name` parameter
- responds with a JSON object that should contain the user's `api_key`
- **GET** - get a user by their API key
- pass in the `Authorization: ApiKey ` header
- ##### `/v1/feeds` - RSS feeds route
- **POST** - creates a feed, takes a `name` & `url` parameter (the URL should point to some sort of `/index.xml`)
- responds with `201` if successful
- pass in the `Authorization: ApiKey ` header
- **GET** - returns an array of feeds (no parameters)
- ##### `/v1/feed_follows` - follow a feed
- **POST** - follows a feed, takes a `feed_id` parameter
- pass in the `Authorization: ApiKey ` header
- responds with `201` if successful
- **GET** - gets the feed(s) a user is following
- pass in the `Authorization: ApiKey ` header
- **DELETE** - `/v1/feed_follows/{feed_follow_id}` - unfollow a feed
- pass in the `Authorization: ApiKey ` header
---