badge-it
badge-it copied to clipboard
pujux
An API serving useful badges for your GitHub Profile README 🚀🎉 Formerly known as git-badges.
git-badges 🎉
Useful badges for your GitHub README
All endpoints support the parameters that you can also use for shields.io badges, you can check out the documentation here shields.io styles.
Currently available badges 🔥
Returns a badge containing the page hit counter for your repository
Endpoint
https://badges.pufler.dev/visits/{username}/{repo}
Markdown
[](https://badges.pufler.dev)
Returns a badge containing the number of years you have been a member
Endpoint
https://badges.pufler.dev/years/{username}
Markdown
[](https://badges.pufler.dev)
Returns a badge containing the number of your public repositories
Endpoint
https://badges.pufler.dev/repos/{username}
Markdown
[](https://badges.pufler.dev)
Returns a badge containing the number of your public gists
Endpoint
https://badges.pufler.dev/gists/{username}
Markdown
[](https://badges.pufler.dev)
Returns a badge that shows when the repository was last updated
Endpoint
https://badges.pufler.dev/updated/{username}/{repo}
Markdown
[](https://badges.pufler.dev)
Returns a badge that shows when the repository was created
Endpoint
https://badges.pufler.dev/created/{username}/{repo}
Markdown
[](https://badges.pufler.dev)
Returns a badge that shows the number of commits you have published in a specified periodicity (yearly, monthly, weekly, daily or all)
Endpoint
https://badges.pufler.dev/commits/{periodicity}/{username}
Markdown
[](https://badges.pufler.dev)
Returns an SVG that displays all contributors of the specified repository
You can specify a size in pixels that will be used for each avatar, a padding in pixels that will be used between the avatars and bots as either 'true' or 'false' to hide bot contributors
Endpoint
https://badges.pufler.dev/contributors/{user}/{repo}?size={size}&padding={padding}&bots=true
Markdown
[](https://badges.pufler.dev)
Self-deployment
If you want to self-deploy git-badges using Docker you can just have a look at the example docker-compose.yml file inside the repository.
Got an idea for a badge? 😀
Create an issue and I will reply soon!
Check out the team 😎
Wanna join us in contributing to git-badges?
git clone https://github.com/puf17640/git-badges
cd git-badges
npm install
# Rename .env.example to .env
# Replace 'github_username' and 'github_token' with your GitHub username,
# and a personal token (no additional permissions required)
# Run MongoDB as a Docker container
docker run -d --rm -p 27017:27017 mongo
npm run start
Your local version of git-badges should now be running on localhost:3000.
pujux