Skip to content
Snippets Groups Projects
introduction.mdx 2.36 KiB
Newer Older
---
sidebar_position: 1
title: Einführung
---

{/* Copyright 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH.
SPDX-License-Identifier: MIT */}

# Badge Programm

Das Badge Programm prüft openCode Repositories und vergibt Badges, die im
[openCode Softwarekatalog](https://opencode.de/de/software) angezeigt werden
und den Status der Repositories in Bezug auf **Wartung**, **Wiederverwendung**
und **Sicherheit** anzeigen.

Mit der Badge-API können Sie interagieren, indem Sie eine Repository-URL übermitteln.
Basierend auf den erfüllten Kriterien des Repositorys erhalten Sie entsprechende
Badges. Zudem stellt die API eine detaillierte Erklärung des Ergebnisses bereit.

## Offizielle Badges auf openCode

Erfahren Sie mehr über die verschiedenen Arten von Badges, die auf openCode verfügbar
sind, und was sie bedeuten, im Abschnitt [Offizielle Badges 🛡️](/de/official-badges/active-maintained-badge).

## Erfahre mehr

Mehr über die Ideen hinter dem Badge-Programm, die implementierten Prüfungen
usw. finden Sie im Abschnitt [Konzepte](/de/concepts).

## Los geht's

### Ausprobieren

Sie können die Badge-API ausprobieren, indem Sie die [API-Live-Demo](/de/#api-small-demo) verwenden.

### API verwenden

Das Herzstück des Badge-Programms ist eine RESTful-API.
Um die Badge-API zu nutzen, können Sie eine Repository-URL übermitteln und erhalten Badges
basierend auf den erfüllten Kriterien. Eine Übersicht aller verfügbaren Endpunkte sowie
deren Verwendung finden Sie in der [API-Dokumentation](/de/api-docs).

### Hoste die Badge-API selbst

Sie können die Badge-API selbst hosten. Wir stellen ein [Helm-Chart zur Bereitstellung
der Badge-API](https://gitlab.opencode.de/open-code/badgebackend/badge-api-helm-chart)
auf einem Kubernetes-Cluster ⎈ zur Verfügung. 
Alternativ können Sie die API lokal als Container oder Bare-Metal ausführen.

### Beitragen zum Badge-Programm

Wir freuen uns über Beiträge zum Badge Programm. Den Quellcode finden Sie auf [openCode](https://gitlab.opencode.de/open-code/badgebackend/badge-api).
Wir freuen uns, wenn Sie die [Richtlinien für Beiträge](https://gitlab.opencode.de/open-code/badgebackend/badge-api/-/blob/main/CONTRIBUTING.md) befolgen.
Zögern Sie nicht, ein Issue (Ticket) zu eröffnen, wenn Sie Fragen haben oder Hilfe benötigen.

## Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert.

Consent

On this website, we use the web analytics service Matomo to analyze and review the use of our website. Through the collected statistics, we can improve our offerings and make them more appealing for you. Here, you can decide whether to allow us to process your data and set corresponding cookies for these purposes, in addition to technically necessary cookies. Further information on data protection—especially regarding "cookies" and "Matomo"—can be found in our privacy policy. You can withdraw your consent at any time.