GoSniff

command module
v0.0.0-...-212c821 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 2, 2025 License: MIT Imports: 20 Imported by: 0

README ΒΆ

πŸ“‘ GoSniff

250317_12h44m11s_screenshot

An RSS feed aggregator built with Go that helps you stay updated with your favorite content! πŸš€

✨ Features

  • πŸ” User Authentication via API Keys
  • πŸ“‚ Feed Management (Create, List, Follow, Unfollow)
  • 🀝 Multi-user Support
  • πŸ”„ Automatic Feed Aggregation
  • πŸ•’ Real-time Updates
  • 🎯 REST API Interface

πŸ› οΈ Technologies

  • Go 1.x
  • PostgreSQL
  • Chi Router
  • SQLC
  • Goose (migrations)

πŸ—οΈ Project Architecture

πŸ“¦ GoSniff ┣ πŸ“‚ internal ┃ β”— πŸ“‚ database # Database models and queries ┣ πŸ“‚ sql ┃ ┣ πŸ“‚ schema # Database migrations ┃ β”— πŸ“‚ queries # SQLC queries β”— πŸ“œ main.go # Application entrypoint

πŸš€ Getting Started

  1. Clone the repository
git clone https://github.com/WST-T/GoSniff.git
  1. Set up your environment variables
.env
# Edit .env with your configuration
It should be something like:
PORT=?
DB_URL=?
  1. Run database migrations
goose postgres "postgres://user:password@localhost:5432/gosniffdb" up
goose postgres "postgres://user:password@localhost:5432/gosniffdb" down
  1. Start the server
go run main.go ||
go build && ./GoSniff

πŸ”„ Feed Aggregator

The feed aggregator worker runs in the background and:

  • ⏰ Periodically checks RSS feeds for updates
  • πŸ“₯ Fetches new content
  • πŸ’Ύ Stores new posts in the database
  • πŸ”” Keeps content fresh and up-to-date

🀝 Contributing

Feel free to open issues and pull requests!

πŸ“ License

MIT License - feel free to use this project however you'd like!

πŸ™ Acknowledgments

  • Chi router for the amazing HTTP routing
  • SQLC for type-safe SQL
  • Goose for easy database migrations
  • And all other open source contributors!

Made with ❀️ using Go

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Directories ΒΆ

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL