Skip to content

README.md

Latest commit

 

History

History
45 lines (32 loc) · 2.51 KB

README.md

File metadata and controls

45 lines (32 loc) · 2.51 KB
Raw

SweetRPG Catalog API

CI Coverage License Issues PRs Dependabot Deployment

HTTP microservice for the SweetRPG Catalog domain (licenses, volumes, contributions, persons, publishers, reviews, studios, systems). A thin Gin-based layer: server/*.go wires JSON:API routes to catalog-data.go's data-access functions.

Run locally

scripts/run-docker-local.sh

Brings up the service plus its MongoDB and Redis dependencies via docker/docker-compose.yml. Swagger UI is served at /swagger/index.html once running.

Known gaps

  • catalog-data.go's Volume entity is the only one with a write path, and Update/Delete are still // TODO stubs there. Every other entity is read-only.
  • No test coverage in server/ or cmd/ yet.

Documentation

Package documentation: pkg.go.dev/github.com/sweetrpg/catalog-api.

Swagger UI (swaggo/swag + gin-swagger, generated from handler annotations, not hand-written): api.catalog.dev.sweetrpg.com/swagger/index.html in dev, or /swagger/index.html against whatever host you're running locally.

Test coverage reports are published to sweetrpg.github.io/catalog-api/coverage.html on every merge to develop.

Contributing

See CONTRIBUTING.md for the development workflow and RELEASE.md for how versions get cut.