https://github.com/haedarrfd/simple-rss-aggregator
A simple RSS Aggregator was built in Go programming language that allows users to create, retrieve, and manage feeds using REST APIs.
https://github.com/haedarrfd/simple-rss-aggregator
go go-chi goose http middleware postgresql rest-api sqlc
Last synced: about 1 year ago
JSON representation
A simple RSS Aggregator was built in Go programming language that allows users to create, retrieve, and manage feeds using REST APIs.
- Host: GitHub
- URL: https://github.com/haedarrfd/simple-rss-aggregator
- Owner: haedarrfd
- Created: 2024-09-21T10:42:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-21T01:37:28.000Z (over 1 year ago)
- Last Synced: 2025-02-07T11:14:50.336Z (about 1 year ago)
- Topics: go, go-chi, goose, http, middleware, postgresql, rest-api, sqlc
- Language: Go
- Homepage:
- Size: 174 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## RSS Aggregator App
An RSS aggregator is a tool that allows you to view and read all the latest posts from your favorite blogs and websites in one place. This simple RSS Aggregator project was built in Go programming language that allows users to create, retrieve, and manage feeds using REST APIs. It uses PostgreSQL as the database and implements authentication using API keys.
## 🔧 Requirements
To run this project, you must have Go, PostgreSQL, Goose and Sqlc installed on your machine.
- Go: Version 1.20 or later
- PostgreSQL: 15.0 or later
- Goose: 3.22 or later
- Sqlc: 1.27 or later
Make sure that PostgreSQL service is running and you should have the necessary credentials for database connection (e.g., username, password, and database name).
## 🔌 Installation
- **If you haven't install goose, use this command to install it (see the documentation [goose](http://pressly.github.io/goose/))**
```
go install github.com/pressly/goose/v3/cmd/goose@latest
```
- **If you haven't install sqlc, use this command to install it (see the documentation [sqlc](https://docs.sqlc.dev/en/stable/index.html))**
```
go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
```
- **Clone this repository**
```
git clone https://github.com/haedarrfd/simple-rss-aggregator.git
cd simple-rss-aggregator
```
- **Adds any missing module requirements**
```
go mod tidy
```
- **Copy the example `.env` file**
```
cp .env.example .env
```
**Note**: If the PostgreSQL database user does not have a password, just leave it blank.
- **Run database migrations**
```
cd postgresql/schema
goose up
```
- **Run the project**
```
go run main.go
```
**Or**
- **Build and run the project**
```
go build && ./simple-rss-aggregator
```
- **Use the project**
To use the project you can use tools like _[Postman](https://www.postman.com/)_ or any other tools to interact with the API.
## 📖 API Reference
#### Create a user
```
POST /v1/users
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `name` | `string` | **Required**. Your name |
#### Get a user by the API key
```
GET /v1/users
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `authorization` | `key` | **Required**. Your API key |
#### Get all feeds
```
GET /v1/feeds
```
#### Create a feed
```
POST /v1/feeds
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `authorization` | `key` | **Required**. Your API key |
| `name` | `string` | **Required**. The name of the feed |
| `url` | `string` | **Required**. The URL of the feed |
| `user_id` | `string` | **Required**. The user who added this feed |
#### Get all feed follows for user
```
GET /v1/feed_follows
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `authorization` | `key` | **Required**. Your API key |
#### Create a feed follow
```
POST /v1/feed_follows
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `authorization` | `key` | **Required**. Your API key |
| `feed_id` | `string` | **Required**. The ID of the feed that user wants to follow |
#### Delete a feed follow
```
DELETE /v1/feed_follows/{feedFollowID}
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `authorization` | `key` | **Required**. Your API key |
| `feedFollowID` | `param` | **Required**. The ID of the feed |
#### Get all posts to a user
```
GET /v1/posts
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `authorization` | `key` | **Required**. Your API key |
## 📁 File Structure
```
.
├── internal
│ ├── auth
│ │ └── auth.go
│ ├── database
│ │ ├── db.go
│ │ ├── feed_follows.sql.go
│ │ ├── feeds.sql.go
│ │ ├── models.sql.go
│ │ ├── posts.sql.go
│ │ └── users.sql.go
├── postgresql
│ ├── queries
│ │ ├── feed_follows.sql
│ │ ├── feeds.sql
│ │ ├── posts.sql
│ │ └── users.sql
│ ├── schema
│ │ ├── 001_users.sql
│ │ ├── 002_feeds.sql
│ │ ├── 003_feed_follows.sql
│ │ └── 004_posts.sql
├── vendor
│ ├── github.com
│ │ ├── go-chi
│ │ │ ├── chi
│ │ │ └── cors
│ │ ├── google
│ │ │ └── uuid
│ │ ├── joho
│ │ │ └── godotenv
│ │ ├── lib
│ │ │ └── pq
│ └── modules.txt
├── .env.example
├── .gitignore
├── go.mod
├── go.sum
├── handler_feed_follows.go
├── handler_feed.go
├── handler_posts.go
├── handler_user.go
├── json.go
├── main.go
├── middleware_auth.go
├── models.go
├── README.md
├── rss.go
├── scraper.go
└── sqlc.yaml
```