Is an easy-to-use API for generating online custom badges and GitHub profiles' summaries and repositories' reports as SVG.

If you like this project, please buy a cup of coffee for me=))☕

&

• JHipsetrize it! =))

• Install and Run
• APIs
  • Counter Badge
  • Social Badges
    • Supported Socials
  • Profile Badge
  • Link Badge
  • Icon Badge
  • Title Badge
• Options
  • Default Colors
  • Random Colors
  • Themes
    • Simple
    • Sharp
    • Edge
  • Sizes
    • Small
    • Medium
    • Large
  • Inline Query Params
    • Params Splitters
• Authors
• Contribution
• Releases
• Issues
• Documentation
• Acknowledgement

Having at least java-11 on your machine installed would be best.

To build the final jar and optimize the Badgify for production, run:

./mvnw -Pprod clean verify

This will concatenate and minify the client CSS and JavaScript files. It will also modify index.html so it references these new files. To ensure everything worked, run:

java -jar target/*.jar

To package Badgify as a war in order to deploy it to an application server, run:

./mvnw -Pprod,war clean verify

To launch Badgify's tests, run:

./mvnw verify

Then navigate to http://localhost:8080 in your browser.

Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:

docker-compose -f src/main/docker/sonar.yml up -d

Note: I have turned off authentication in src/main/docker/sonar.yml for out of the box experience while trying out SonarQube, for real use cases turn it back on.

You can run a Sonar analysis with using the sonar-scanner or by using the maven plugin.

Then, run a Sonar analysis:

./mvnw -Pprod clean verify sonar:sonar

If you need to re-run the Sonar phase, please be sure to specify at least the initialize phase since Sonar properties are loaded from the sonar-project.properties file.

./mvnw initialize sonar:sonar

You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the src/main/docker folder to launch required third party services.

For example, to start a mysql database in a docker container, run:

docker-compose -f src/main/docker/mysql.yml up -d

To stop it and remove the container, run:

docker-compose -f src/main/docker/mysql.yml down

You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:

npm run java:docker

Or build a arm64 docker image when using an arm64 processor os like MacOS with M1 processor family running:

npm run java:docker:arm64

Then run:

docker-compose -f src/main/docker/app.yml up -d

When running Docker Desktop on MacOS Big Sur or later, consider enabling experimental Use the new Virtualization framework for better processing performance (disk access performance is worse).

For more information refer to [Using Docker and Docker-Compose][], this page also contains information on the docker-compose sub-generator (jhipster docker-compose), which is able to generate docker configurations for one or several JHipster applications.

GET http://localhost:8080/api/badge/lable

OPTIONS

• text: String
• icon: Icon
• fontColor: Color
• backgroundColor: Color
• size: Size
• theme: Theme

http://localhost:8080/api/badge/label?text=Badgify&fontColor=lavender&size=l&theme=simple&backgroundColor=indigo&icon=github

GET http://localhost:8080/api/badge/icon

OPTIONS

• icon: Icon
• fontColor: Color
• backgroundColor: Color
• size: Size
• theme: Theme

http://localhost:8080/api/badge/icon?fontColor=lavender&size=l&theme=simple&backgroundColor=indigo&icon=github

GET http://localhost:8080/api/badge/text

OPTIONS

• text: String
• fontColor: Color
• backgroundColor: Color
• size: Size
• theme: Theme

http://localhost:8080/api/badge/text?fontColor=lavender&size=l&theme=simple&backgroundColor=indigo&text=Badgify

GET http://localhost:8080/api/badge/counter

OPTIONS

• id: String (required)
• type: repository (required)
• text: String
• fontColor: Color
• backgroundColor: Color
• size: Size
• theme: Theme

http://localhost:8080/api/badge/counter?fontColor=lavender&size=l&theme=simple&backgroundColor=indigo&type=repository&icon=github&id=Badgify

GET http://localhost:8080/api/badge/{social}/{id}

OPTIONS

• text: String
• icon: Icon
• fontColor: Color
• backgroundColor: Color
• size: Size
• theme: Theme

http://localhost:8080/api/badge/twitter/shuoros

app-store

http://localhost:8080/api/badge/app_store/{id}

behance

http://localhost:8080/api/badge/behance/{id}

discord

http://localhost:8080/api/badge/discord/{id}

dockerhub

http://localhost:8080/api/badge/dockerhub/{id}

dribbble

http://localhost:8080/api/badge/dribbble/{id}

dropbox

http://localhost:8080/api/badge/dropbox/{id}

facebook

http://localhost:8080/api/badge/facebook/{id}

github

http://localhost:8080/api/badge/github/{id}

gitlab

http://localhost:8080/api/badge/gitlab/{id}

goodreads

http://localhost:8080/api/badge/goodreads/{id}

google-drive

http://localhost:8080/api/badge/google_drive/{id}

google-play

http://localhost:8080/api/badge/google_play/{id}

instagram

http://localhost:8080/api/badge/instagram/{id}

kaggle

http://localhost:8080/api/badge/kaggle/{id}

kickstarter

http://localhost:8080/api/badge/kickstarter/{id}

linkedin

http://localhost:8080/api/badge/linkedin/{id}

medium

http://localhost:8080/api/badge/medium/{id}

paypal

http://localhost:8080/api/badge/paypal/{id}

pinterest

http://localhost:8080/api/badge/pinterest/{id}

quora

http://localhost:8080/api/badge/quora/{id}

reddit

http://localhost:8080/api/badge/reddit/{id}

skype

http://localhost:8080/api/badge/skype/{id}

slack

http://localhost:8080/api/badge/slack/{id}

snapchat

http://localhost:8080/api/badge/snapchat/{id}

spotify

http://localhost:8080/api/badge/spotify/{id}

stack-exchange

http://localhost:8080/api/badge/stackexchange/{id}

stackoverflow

http://localhost:8080/api/badge/stackoverflow/{id}

steam

http://localhost:8080/api/badge/app_store/{id}

telegram

http://localhost:8080/api/badge/telegram/{id}

tiktok

http://localhost:8080/api/badge/tiktok/{id}

twitch

http://localhost:8080/api/badge/twitch/{id}

twitter

http://localhost:8080/api/badge/twitter/{id}

yahoo-mail

http://localhost:8080/api/badge/yahoo_mail/{id}

youtube

http://localhost:8080/api/badge/youtube/{id}

If there is a missed social media please let me now by creating a new Issue

Here are quick examples of how to use APIs. For more information, please visit the badgify website or read the /docs.

Instead of passing colors as hex you can use our pre-defined default colors names:

badgify.thex.solutions/api/badge/title?title=color&bg=<COLOR_NAME>

Colors names aren't case-sensitive!

Thinking of a new cool color? Please let us know<3.

For generating random colors you can use the following api with a random param as bg or color :

badgify.thex.solutions/api/badge/title?title=random&bg=random

We strongly recommend you to do not use random colors for badge's text color! Because the produced random color may not match the background color in contrast and make it difficult to see your text in the badge.

You can choose one of the available themes for your badge.

Simple is default theme of badges. If you want to use this theme, you do not need to pass it in parameters.

badgify.thex.solutions/api/badge/link?title=Simple&icon=github

badgify.thex.solutions/api/badge/title?title=Simple

badgify.thex.solutions/api/badge/icon?icon=github

To use this theme in your badges, you must pass theme=sharp parameter in your request.

badgify.thex.solutions/api/badge/link?title=Sharp&icon=github&theme=sharp

badgify.thex.solutions/api/badge/title?title=Sharp&theme=sharp

badgify.thex.solutions/api/badge/icon?icon=github&theme=sharp

To use this theme in your badges, you must pass theme=edge parameter in your request.

badgify.thex.solutions/api/badge/link?title=Edge&icon=github&theme=edge

badgify.thex.solutions/api/badge/title?title=Edge&theme=edge

badgify.thex.solutions/api/badge/icon?icon=github&theme=edge

Any idea about new themes? Feel free to tell us<3

There are three renderable sizes for badges. Small, medium and large that you can choose any of these sizes for your badge.

Small is default size of badges. If you want to use this size, you do not need to pass it in parameters.

badgify.thex.solutions/api/badge/link?title=Small&icon=github

badgify.thex.solutions/api/badge/title?title=Small

badgify.thex.solutions/api/badge/icon?icon=github

To use medium size for your badges, you must pass size=m parameter in your request.

badgify.thex.solutions/api/badge/link?title=Medium&icon=github&size=m

badgify.thex.solutions/api/badge/title?title=Medium&size=m

badgify.thex.solutions/api/badge/icon?icon=github&size=m

To use large size for your badges, you must pass size=l parameter in your request.

badgify.thex.solutions/api/badge/link?title=Large&icon=github&size=l

badgify.thex.solutions/api/badge/title?title=Large&size=l

badgify.thex.solutions/api/badge/icon?icon=github&size=l

Instead of passing the params as query params you can use inline params to just pass a string as design:

badgify.thex.solutions/api/badge/inline/<BADGE>/<SOME_DESIGN>

Or want to pass less params? You can use short inline:

badgify.thex.solutions/api/badge/inline/<BADGE>/<SOME_SHORT_DESIGN>

You can use underscore, hyphen or space as a param splitter.

param1 param2 param3...

param1_param2_param3...

param1-param2-param3...

Please take a look at each badge's examples to see how to use inline params.

badgify is developed by Soroush Shemshadi and contributors.

If you want to contribute on this project, Please read the contribution guide.

To see the changes in different versions of badgify, you can read the release notes.

If you encounter a bug or vulnerability, please read the issue policy.

To learn how to work with badgify, please take a look at the /docs folder.

A great thanks to @sarahrajabi for designing the icon.

And thanks to all the contributors, the people who reported the bugs and all those who made it possible for us to provide this great software.