||1 month ago|
|badges||2 months ago|
|frontend||1 month ago|
|webservice||1 month ago|
|.gitignore||3 months ago|
|LICENSE.txt||4 months ago|
|NOTICE.txt||2 months ago|
|README.md||2 months ago|
|RELEASES.md||1 month ago|
|logo.svg||2 months ago|
A web service and GUI for ./badges
This repository contains a web service and GUI for generating and downloading repository badges, powered by ./badges.
The ./badges web service is a small REST webservice, written in Go.
To build it, simply run
For a development server, you can run
go run main.go
The web service exposes an
/openapi.json endpoint, that gives a description of
the service's endpoints.
It also exposes a
/templates endpoint, that provides an index of all available
templates and for each template a list of available themes as well as each theme's
Configuration of the webservice is done by passing in a JSON file
-c command line parameter. An example configuration file
is provided in
In its default configuration, it is configured for allowing any Cross-Origin requests. You can configure a stricter setting in the server configuration file.
By default, the webservice will support the template and themes built into ./badges.
Building the entire GUI
It features live-updating badges and interactive selection of themes, as well as example Markdown generation.
You can configure it using the
frontend/.env file, where you can set the
web service URL and whether the download and remote inclusion sections should
To run it, first make sure the web service (see above) is running and its URL
is configured in the file
frontend/.env. Then run:
npm run serve
for a development server and
npm run build
for a production build.
The GUI is suitable for local use. For production use, you might need to add
legal and privacy links as well as further copyright attribution, if you use
custom themes and templates. For these customizations, it is suggested to
include the GUI as a NPM dependency and to re-use its components or to create
your custom fork, modifying
App.vue and other relevant files in place.
Reusing the GUI components
The GUI components are published on npm and can be re-used in your own
application. Please be sure to include
NOTICE in this scenario.
npm install dot-slash-badges-web
Feel free to contribute by posting issues on this project's Issue Tracker.
Please note that pull requests are only accepted if they are in line with the licensing of the rest of the project (see below).
Copyright and Licensing
./badges web is (C) 2021 Lucas Hinderberger
It is licensed under the Apache Licence Version 2.0.
The output of the ./badges generator using the built-in fonts, themes and templates is unencumbered by copyright restrictions (to the extent possible under law), due to the built-in fonts, themes and templates being released under CC0 1.0 Universal.
Author and Contact
./badges web is authored by Lucas Hinderberger. For contact data, see https://lhinderberger.com/impressum
The repository of ./badges web can be found at https://codeberg.org/lhinderberger/dot-slash-badges-web
You're welcome to file bug reports, other issues and pull requests there.
You can also contact the author via email at email@example.com