https://github.com/belovetech/gator
RSS aggregator
https://github.com/belovetech/gator
golang goose postgresql sqlc
Last synced: 7 months ago
JSON representation
RSS aggregator
- Host: GitHub
- URL: https://github.com/belovetech/gator
- Owner: belovetech
- Created: 2024-10-21T12:40:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T21:49:46.000Z (over 1 year ago)
- Last Synced: 2024-10-25T16:54:37.501Z (over 1 year ago)
- Topics: golang, goose, postgresql, sqlc
- Language: Go
- Homepage:
- Size: 1.44 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gator
## RSS Aggregator
Gator is a simple RSS aggregator built with Go that allows users to manage and aggregate RSS feeds efficiently.
### Configuration
To set up the configuration for Gator, follow these steps:
1. Create the configuration file:
```bash
touch ~/.gatorconfig.json
```
2. Edit the content of ~/.gatorconfig.json:
```json
{
"db_url": "postgres://:@localhost:5432/gator?sslmode=disable"
}
```
Replace with your PostgreSQL username.
### How to Use
Clone the repository:
```bash
git clone https://github.com/belovetech/gator.git
```
Change directory to the cloned repository:
install goose CLI:
```bash
go install github.com/pressly/goose/v3/cmd/goose@latest
goose -v
```
Install the dependencies:
```bash
go mod tidy
```
Run the migrations:
```bash
make migrate-up
```
Build the application:
```bash
go build -o gator
```
Once the configuration is set up, you can use the following commands to interact with Gator:
```bash
./gator reset # Reset the application to its initial state
./gator login # Log in to your account
./gator register # Register a new user
./gator users # List all users
./gator addfeed # Add a new RSS feed
./gator agg # Aggregate the RSS feeds
./gator feeds # List all feeds
./gator follow # Follow a feed
./gator unfollow # Unfollow a feed
./gator following # List the feeds you are following
./gator browse # Browse the posts
```
### Prerequisites
- Go (Golang) installed on your machine
- PostgreSQL database running locally