README
¶
SweetRPG Game Systems API
HTTP microservice that owns the platform-wide catalog of game systems (ruleset/edition, name,
publisher reference, metadata). A Gin-based Go service, matching catalog-api's conventions,
backed by its own MongoDB database.
catalog-api resolves a Volume's system references against this service rather than
maintaining its own copy - see sweetrpg/platform's openspec/changes/game-systems-service for
the full design.
Run locally
go run ./cmd/game-systems-api
Needs a MongoDB instance reachable per mongodb.go's DB_* environment variables (DB_URI, or
DB_HOST/DB_SCHEME/DB_USER/DB_PW/DB_NAME/DB_PORT/DB_OPTS).
Documentation
Package documentation: pkg.go.dev/github.com/sweetrpg/game-systems-api.
Contributing
See CONTRIBUTING.md for the development workflow.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
backfill-audit-fields
command
Command backfill-audit-fields populates the platform audit fields (PADR-0001) on game_systems_meta records that predate the convention: updated_at / updated_by (mirrored from created_at / created_by), leaving deleted_at / deleted_by null.
|
Command backfill-audit-fields populates the platform audit fields (PADR-0001) on game_systems_meta records that predate the convention: updated_at / updated_by (mirrored from created_at / created_by), leaving deleted_at / deleted_by null. |
|
game-systems-api
command
|
|
|
migrate-system-ids
command
|
|
|
internal
|
|
Click to show internal directories.
Click to hide internal directories.