Skip to content

trob9/bingoplz

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bingoplz

Bingo with goals that reset monthly. Set and submit your goals, and they are arranged at random into a bingo card that only your friends can see. You can see your friends bingo cards (and goals if they choose to reveal them) and vice versa, however you cannot see the layout of your own goals on your own grid - you just need to complete your goals in the hopes that you get bingo before your friends do!

Quick Start

Prerequisites

# Install protoc
brew install protobuf

# Install Go proto plugins
make install-tools

Setup

  1. Start local dependencies:
make docker-up
  1. Generate proto code:
make proto
  1. Run the server:
make run

Development Commands

  • make proto - Generate Go code from .proto files
  • make run - Run the server
  • make docker-up - Start PostgreSQL
  • make docker-down - Stop PostgreSQL

Business Logic

See business_rules.md

API Design

The gRPC API follows Google's API Improvement Proposals (AIP):

  • Resource-oriented design (AIP-121)
  • Standard methods: Get, List, Create, Update, Delete (AIP-131-135)
  • Resource naming: users/{user_id}/goal-cards/{card_id}

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published