A simple command-line tool for managing RSS feeds.
Multiple users can log in and use it. Each user can add, follow, and unfollow feeds, and check their posts.
It uses a PostgreSQL database to store users, feeds, follow relationships, and posts. I used the CLI tool goose to manage database migrations and sqlc to generate Go code from SQL queries. And used the testify & httptest packages to write the the unit tests.
This project was built using a TDD approach (although it wasn’t required) where tests are written before the implementation. It was challenging and sometimes frustrating, but ultimately rewarding since I learned more about unit testing in Go and how to use mocking to build unit tests—especially for database and external server interactions.
And shout out to ChatGPT for its coding tips. I don’t have the experience to judge the cleanliness of the code, but I can say it helped me organize this project in a cleaner way than I could on my own.
To see all available commands, run:
gator cmndsFor help on a specific command:
gator man <command-name>I won’t spoil all the supported commands here—check them yourself :)
But here's a thing:
To stop it, use Ctrl + c keys.
To make it run in the background, there are two ways:
Just append & at the end:
gator agg 10s &To kill it:
- Get its job number from the output of
jobscommand - Bring it to the foreground
fg %<job-number> - Kill it with
kill %<job-number>
Or just get its process ID and run kill <PID>.
Nevertheless, it stops if you close the termainal.
Use nohup:
nohup gator agg > agg.log 2>&1 &This detaches the process from the terminal and the output will go into agg.log.
The process keeps running even if you log out or close the terminal.
You can kill it later with kill <PID>.
- Go 1.20+
- PostgreSQL (running locally or remotely)
- (Optional)
goosefor database migrations
You have two easy options:
You need to have Go installed in your machine.
go install github.com/MaysHroub/gator@latestYou need to have Git installed in your machine.
git clone https://github.com/MaysHroub/gator.git
cd gator
go build -o gator./gator <command-name> [command-args]This is an example of how you might use Gator:
gator register mays-alreem
gator addfeed https://techcrunch.com/feed/
gator follow https://news.ycombinator.com/rss
gator agg 20sThis project was built as part of the Backend-Go track on boot.dev.
The following were good resources that helped me learn how to write solid unit tests in Go:
Learn Go using TDD - Mocking (This one is super good, but check the dependency injection part first)
I didn't read these ones before, but they seem solid:
Comprehensive Guide to Testing in Go
How to use mock testing in Go (This one is also good)
I don't understand why good resources only show up when I finish.