Visitor counter badge is a simple API which serves badge from shields.io. You can use this badge to count visitors for your GitHub Repositories or even your personal sites. The usage is very simple.
You need a key and a value to create a unique query combination which will eventually be used to count visitors. So considering you want to use the badge for your repository, user/repo-name can be a good unique query. For example https://visitor-counter-badge.vercel.app/api/username/repo-name/ will return a badge where username is your github username and repo-name is your repository name.
You can customize the badge by passing the following parameters:
| Parameter | Description | Default |
|---|---|---|
| style | style of badge | for-the-badge |
| label | label name | Visitors |
| color | color for right side of badge | 5c5866 |
| labelColor | color for left side of badge | 2b2930 |
For avaialble styles and color types, please refer to shields.io site.
Clone the repository
git clone https://github.com/asheeeshh/visitor-counter-badge.gitInstall dependencies
cd visitor-counter-badge
npm installRun the app
npm run devYou can deploy this app to any of the below platforms in one click.
| Platform | Button |
|---|---|
| Vercel | |
| Netlify |  |
| Cloudflare Workers |
The API depends upon countapi for counting visitors. Though it's kind of impossible, still if you get ratelimited by the API you can just host your own instance of this API using Vercel and get unlimited personal requests!
MIT
- If you find this project helpful, consider giving it a ⭐.
- Checkout my other projects too 💜.