barretthousen/README.md

1.9 KiB

Barretthousen

Search and get alerts for items across the most popular auction sites.

Goals

  1. Ability to search upcoming and live auctions across major auction sites
  2. Get an email digest of upcoming auctions for the week

Future goals

  1. Get email alerts when these auctions are about to go live
  2. Specify search criteria for email alerts

Technology

For Users

For Admins

Arcchitecure Diagram MVP

Services

  • Web-client Frontend site that users access to browse upcoming auctions and subscribe for updates to their searches

  • Catalog API for searching upcoming auctions.

  • Ringman Manages email subscriptions and sending emails to users about upcoming auctions.

  • Runner Scrapes sites for upcoming auctions. Transforms the data into a suitable shape and stores it for use by the frontend.

  • Auctioneer Enables site administrators to kicks off scrape and email jobs in Runner and Ringman, and view status on current/past jobs.

  • BHDB Monolithic postgres datbabase tying it all together

Contributing

Install asdf and run hack/asdf_plugin_setup

make setup # install asdf stuff and build tooling

make gen # generate protobufs and sql boilerplate

make dev # spin up a k8s cluster, build and deploy servicces w/ hot reloading