Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 2.8 KB

README.md

File metadata and controls

60 lines (35 loc) · 2.8 KB

vercel-badge

Vercel

Simple serverless service/utility for embedding a Vercel deployment badge in your public github repository or on your website.

Usage

![Vercel](https://vercelbadge.vercel.app/api/[owner]/[repo])

Replace [owner] with the username of the repo owner, or the organization name under which the repository is located.

Replace [repo] with the repository name.

(optional) Add the ?style= parameter to change the visual badge style.

Parameter Types Description Example
style Default: flat
Available: flat, flat-square, for-the-badge, plastic
Select the visual style for your badge. https://vercelbadge.vercel.app/api/datejer/vercel-badge?style=for-the-badge

Examples

These are all of the possible Vercel deployment statuses. (flat style)

Passing Demo Pending Demo Failed Demo None Demo


flat-square style: Passing Flat Square Demo

for-the-badge style: Passing For The Badge Demo

plastic style: Passing Plastic Demo


Ratelimits

This project uses the GitHub API with an OAuth app's ID and Secret to authenticate requests in order to up the ratelimit to 5k requests per hour. The publicly available deployment uses my private OAuth app credentials, so it's highly advised to deploy your own Vercel instance with your own credentials to avoid ratelimiting, especially with bigger projects.

You can check the current GitHub API ratelimit by GETing /api/ratelimit

GET https://vercelbadge.vercel.app/api/ratelimit

Deploying

Deploy with Vercel

You can deploy your own Vercel instance of this project. In order to do that you must create a GitHub OAuth app and pass the Client ID and Client Secret as two environment variables. (respectively ID and SECRET)

Contributing

Please refer to CONTRIBUTING.md