https://github.com/wrouesnel/badgeserv

No-Nonsense badge generator service. Ideal for on-premises hosting!
https://github.com/wrouesnel/badgeserv

Last synced: about 1 month ago
JSON representation

No-Nonsense badge generator service. Ideal for on-premises hosting!

• Host: GitHub
• URL: https://github.com/wrouesnel/badgeserv
• Owner: wrouesnel
• License: mit
• Created: 2022-10-12T00:05:23.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-16T00:05:19.000Z (over 1 year ago)
• Last Synced: 2024-06-21T11:00:19.462Z (6 months ago)
• Language: Go
• Size: 1.59 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - wrouesnel/badgeserv - No-Nonsense badge generator service. Ideal for on-premises hosting! (Go)

README

        
[![Build and Test](https://github.com/wrouesnel/badgeserv/actions/workflows/integration.yml/badge.svg)](https://github.com/wrouesnel/badgeserv/actions/workflows/integration.yml)

[![Release](https://github.com/wrouesnel/badgeserv/actions/workflows/release.yml/badge.svg)](https://github.com/wrouesnel/badgeserv/actions/workflows/release.yml)

[![Container Build](https://github.com/wrouesnel/badgeserv/actions/workflows/container.yml/badge.svg)](https://github.com/wrouesnel/badgeserv/actions/workflows/container.yml)

[![Coverage Status](https://coveralls.io/repos/github/wrouesnel/badgeserv/badge.svg?branch=main)](https://coveralls.io/github/wrouesnel/badgeserv?branch=main)

[![Go Report Card](https://goreportcard.com/badge/github.com/wrouesnel/badgeserv)

# BadgeServ

No-Nonsense badge generator service. Ideal for on-premises hosting!

## Purpose

BadgeServ is designed to be completely un-opinionated about what sort of data you want to display, but to make displaying

any data easy. It includes no built-in badges or services at all and is intneded principally for supporting private

deployments which could benefit from a badge-generator service.

## Usage

This is an entirely stateless service. Run it with:

```shell

docker run -it --rm -p 8080:8080 ghcr.io/wrouesnel/badgeserv

```

And visit http://127.0.0.1:8080 to use it.

### Web UI

The Web UI is the easiest way to make badges - simply enter your parameters, and the badge sample will be generated

in your browser. Copying the image link will allow you to embed it on any other page.

### Swagger UI

All features can be explored from the swagger UI at `/api/v1/ui`

### Static Badges

`GET /api/v1/badge/static?name=Name&value=Value&color=green`

Generate simple badges directly from a URL.

### Custom Badges

`GET /api/v1/badge/dynamic/?target=https://my-json-service/this/should/be/encoded/properly&label=This can be Pongo2&message=So can this {{like.with.a.value}}`

Generate dynamic badges from any JSON endpoint using [pongo2](https://github.com/flosch/pongo2) for data

extraction.

Pongo2 is a Jinja2-like syntax derivative for Go, and is chosen because it provides advanced features like conditions

and text handling. Using this language in badge queries, almost any type of data can be handled.

### Predefined Badges

`GET /api/v1/badge//?param1=something&param2=something`

The predefined badge endpoints can be customized and configured when the service is deployed. This is a handy solution

for surfacing data which requires authentication tokens to retrieve. BadgeServ supports retrieving secrets from

Hashicorp Vault directly, for maximum configuration security.

## Coming Soon

The following features will be implemented soon

### Endpoint Badges

Endpoint badges implement a compatible interface similar to [shields.io](https://shields.io) and [badgen.net](https://badgen.net).

## Acknowledgements

Adapted from original code by [Luzifer/badge-gen](https://github.com/Luzifer/badge-gen).