By deploying your code (or running it locally with npm start) any call made to the /api endpoint will be proxied to https://example.org.
Check the documentation of the http-proxy-middleware library (and of the node-http-proxy library, used under-the-hood) to learn how you can manipulate the proxied request & response.
Since the GitHub API only allows 5k requests per hour, my https://github-readme-stats.vercel.app/api
could possibly hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started!
NOTE: Since #58 we should be able to handle more than 5k requests and have no issues with downtime :D
Guide on setting up Vercel ๐จ
- Go to vercel.com
- Click on
Log in
- Sign in with GitHub by pressing
Continue with GitHub
- Sign in to GitHub and allow access to all repositories, if prompted
- Fork this repo
- After forking the repo, open the
vercel.json
file and change themaxDuration
field to10
- Go back to your Vercel dashboard
- Select
Import Project
- Select
Import Git Repository
. Select root and keep everything as is. - Create a personal access token (PAT) here and enable the
repo
permissions (this allows access to see private repo stats) - Add the PAT as an environment variable named
PAT_1
(as shown). - Click deploy, and you're good to go. See your domains to use the API!
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free.
However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:-
- Giving proper credit when you use github-readme-stats on your readme, linking back to it :D
- Starring and sharing the project ๐
- - You can make one-time donations via PayPal. I'll probably buy a
coffeetea. ๐ต
Thanks! โค๏ธ
Contributions are welcome! <3
Made with โค๏ธ and JavaScript.