Barretthousen
/
barretthousen
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6 Commits
5 Branches
0 Tags
54 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'feat/swagger'
${ noResults }
Go to file
Adam Veldhousen cff1ee17f1
ci.vdhsn.com/push Build is failing Details
attempt 1 		11 months ago
.vscode MVP build (#1) 11 months ago
doc MVP build (#1) 11 months ago
env attempt 1 11 months ago
src attempt 1 11 months ago
.drone.yml MVP build (#1) 11 months ago
.gitignore MVP build (#1) 11 months ago
.sops.yaml MVP build (#1) 11 months ago
.tool-versions MVP build (#1) 11 months ago
LICENSE docs and architecture planning 1 year ago
Makefile attempt 1 11 months ago
README.md note about startup 11 months ago
Tiltfile attempt 1 11 months ago
go.work Squashed commit of the following: 11 months ago
go.work.sum MVP build (#1) 11 months ago

README.md

Barretthousen

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

Built with microservice architecture and various fancy tools for learning purposes

Links

Technology

This project is for fun and learning so there are a lot of tools at play:

Infra

  • Tilt: local development env orchestration
  • Ctlptl: Automate local kubernetes clusters for local dev
  • Docker
  • Postgres:
  • Traefik:
  • Kustomize:
  • Helm:

Backend

  • Go
  • goose: Go SQL db migration tool
  • Sqlc: Generate Go code to query SQL databases from migrations in a type safe way
  • Buf: Nice frontend for protoc and .proto libraries
  • Protobufs:

Frontend

Diagram

Services

Auction terms glossary

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

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

  • Catalog API for searching upcoming auctions.

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

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

  • Proxy-web Proxies JSON HTTP API requests for the web client to GRPC based services downstream

  • Proxy-admin Proxies JSON HTTP API requests for the admin client to GRPC based services downstream

Contributing

You will need the following prereqs installed:

Everything you need is in the makefile:

# install asdf tools, sqlc, buf
make setup

# generate protobufs and sql boilerplate
make gen

# spin up a k8s cluster, build and deploy services locally w/ hot reloading - be patient this takes a few minutes first run
make dev

# build production docker images for the backend microservices, optionally push to the respective env
make build-backend-image SERVICE=[catalog, runner, proxy-web, proxy-admin] [ENV=[beta, prod]]

# build client docker image for web frontends, optionally push to the respective env
make build-client-image SERVICE=[web-client, admin-client] [ENV=[beta, prod]]

# acceptance tests
make acceptance-test SERVICE=[runner,catalog] ORIGIN=[beta.barretthousen.com,beta.admin.barretthousen.com]

For how to deploy read me.