credit-tracker

module
v0.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 29, 2025 License: Apache-2.0

README

DIMO Credit Tracker

GitHub license GoDoc Go Report Card

The DIMO Credit Tracker is a service that manages and tracks credits within the DIMO Developer.

Prerequisites

  • Go 1.24 or later
  • Docker (for containerized deployment)

Configuration

The service is configured using a YAML settings file. A sample configuration file is provided in settings.sample.yaml. Copy this file to settings.yaml and adjust the settings as needed.

Development

Available Make Commands
> make help
Specify a subcommand:
  build                build the binary
  run                  run the binary
  clean                clean the binary
  install              install the binary
  tidy                 tidy the go mod
  test                 run tests
  lint                 run linter
  docker               build docker image
  tools-golangci-lint  install golangci-lint
  tools-protoc         install protoc
  generate             run all file generation for the project
  generate-swagger     generate swagger documentation
  generate-go          run go generate
  generate-grpc        generate grpc files

API Documentation

The API documentation is available via Swagger UI /swagger when the service is running. The documentation is automatically generated from the code annotations.

Directories

Path Synopsis
cmd
credit-tracker command
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
internal
app
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL