Skip to content

Microservice for managing grocery items @erazemk

License

Notifications You must be signed in to change notification settings

MultimoML/dispatcher

Repository files navigation

Dispatcher

Microservice for managing grocery items.

Available endpoints:

  • /live: Liveliness check
  • /ready: Readiness check
  • /v1/all: Returns a list of all products
  • /v1/:id: Returns a single product by id

Available query parameters:

  • limit: The number of returned products
  • offset: Which product to start from
  • sort: Sort by field (none, name, price, category)
  • order: Sort order (asc, desc)
  • history: Limit number of prices to display per item (last, none, all)
  • category: Filter by category name

Branches:

  • main: Contains latest development version
  • prod: Contains stable, tagged releases

Setup/installation

Prerequisites:

Example usage:

  • See all available options: make help
  • Run microservice in a container: make run
  • Release a new version: make release ver=x.y.z

All work should be done on main, prod should never be checked out or manually edited. When releasing, the changes are merged into prod and both branches are pushed. A GitHub Action workflow will then build and publish the image to GHCR, and deploy it to Kubernetes.

License

Multimo is licensed under the GNU AGPLv3 license.