iamnande / cardmod Goto Github PK

TODO: add a simple GitHub action workflow to run:

• proto generation diff (ensure generated files are committed)
• golangci-lint (should already be completed)
• unit tests (follow up to write them)

ref: https://gamefaqs.gamespot.com/ps4/266152-final-fantasy-viii-remastered/faqs/72431/items

Figure out a way to seed the known cards and magic into the database. CLI, db migration(proper?), etc.

ref: https://gamefaqs.gamespot.com/ps4/266152-final-fantasy-viii-remastered/faqs/72431/triple-triad#card-list-common-cards
ref: https://gamefaqs.gamespot.com/ps4/266152-final-fantasy-viii-remastered/faqs/72431/magic#offensive-magic
ref: https://gamefaqs.gamespot.com/ps4/266152-final-fantasy-viii-remastered/faqs/72431/magic#restorative-magic
ref: https://gamefaqs.gamespot.com/ps4/266152-final-fantasy-viii-remastered/faqs/72431/magic#indirect-magic

either need a filter query parameter or a generalized search endpoint (leaning toward the former).

could add a method like (searching by name; duplicated for magics as well):

SearchCards(ctx context.Context, query string) ([]card.Card, error)

that would go here. it would only be used by the seeder program. the implementation would go here.

https://google.aip.dev/193

https://github.com/googleapis/api-common-protos/blob/main/google/rpc/error_details.proto

https://github.com/grpc/grpc-go/blob/master/examples/features/errors/server/main.go

able to send a collection
able to receive a collection of options (some magic have multiple card relationships)

utilize a sync/once pattern to ensure the repositories are initialized only once.

just to see how this structures' testing UX is like

they're not quite magic but they're treated the same. magic would need a category or type attribute with an enum of either:
Magic or Limit Break (still technically can be/contain magic IG so....)

Gesper Card > Black Hole > Degenerator (Level 1)
4x Malboro Card > Malboro Tentacle > Bad Breath (Level 5)
10x Ruby Dragon Card > Inferno Fang > Fire Breath (Level 5)
10x Behemoth Card > Barrier > Mighty Guard (Level 5)
SAM08G Card > Running Fire > Gatling Gun (Level 3)
Fastitocalon Card > Water Crystal > Aqua Breath (Level 3)
Creeps Card > Coral Fragment > Electrocute (Level 2)
Gayla Card > Mystery Fluid > Acid (Level 1)
Tri-Face Card > Curse Spike > L?Death (Level 3)
Caterchipillar Card > Spider Web > Ultra Waves (Level 1; if you fought a Caterchipillar you might already have this)

most of the contributing guide right now is focused around getting everything installed and understanding what's there. we should add a section on what the intended workflow looks like.

"Making a Change" does exist but originally the idea was to keep that focused around the git and PR workflow. The current "Making a Change" should probably either be renamed or expanded to include the development workflow.