Badge Programm

The Badge Programm checks openCode repositories and granting badges which are displayed in the openCode software catalog and indicate the status of the repository in terms of security, maintenance, and reuse.

You can interact with the Badge API by submitting a repository URL and receiving a badge based on the criteria that the repository meets. The API will provide you a detailed explanation of the result too.

Official Badges on openCode

Learn about the different types of badges that are available on openCode and what they mean in the Official Badges 🛡️ section.

Learn more

Learn more about the ideas behind the Badge Programm, implemented checks, etc. in the Concepts section.

Getting started

Try it out

You can try out the Badge API by using the API Live Demo.

Use the API

To use the Badge RESTful API, you can submit a repository URL to the API and receive badges based on the criteria that the repository meets. See all available endpoints and how to use them in the API documentation.

Host the Badge API yourself

You can host the Badge API yourself. We provide a Helm chart to deploy the Badge API on a Kubernetes cluster ⎈. Alternatively, you can run the API locally as container or bare metal.

Contribute to the Badge API

We are happy to receive contributions to the Badge API. You can find the source code on openCode. We welcome you to follow the contribution guidelines. Do not hesitate to open an issue if you have any questions or need help.

License

This project is licensed under the MIT License.