extractor

command module
v0.0.0-...-593e5b2 Latest Latest
Warning

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

Go to latest
Published: Jan 10, 2023 License: AGPL-3.0 Imports: 5 Imported by: 0

README

Extractor

Microservice to extract data from online shops.

Available endpoints:

  • /self: Liveliness and readiness check
  • /v1/info: Returns internal state of extractor
  • /v1/extract: Signals extractor to initiate a new extraction

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

Project is licensed under the GNU AGPLv3 license.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
internal

Jump to

Keyboard shortcuts

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