Add documentation explaining how to host on Vercel

[pylapp]

Hi @ryo-ma!

I read on the README of the project is it possible to host the tool on our own Vercel instance.
Could you share some details about how a user can do it for its own needs?
Some people (like me) are not used to Vercel at all, thus a bit of help could be nice :-)

Thanks!

[pylapp]

Maybe @kann4n @adwitya @hesreallyhim @hongbo-wei could share how they use Vercel?

[hesreallyhim]

@pylapp for sure, I'll prepare a tutorial shortly. First thing is to just sign up on vercel. You should be able to use a free account. If you connect it with your GitHub it will make everything super simple. Will get back to you with more details.

[kann4n]

@pylapp In issue #383. Provided a walkthrough, including how to set up the required Personal Access Token (PAT).

[hesreallyhim]

Thanks @kann4n this looks correct to me.

[hesreallyhim]

@pylapp just to add some context:

• github-profile-trophy has two parts: (i) the static site, which has input fields to help you generate your trophies; (ii) the actual API endpoint that serves the trophies. By default, some of the code for the static site still references the upstream repository's (i.e. this repo) deployment - so you may find that the "Get Trophy's" button does not work - if this repo's server is down, that's expected - you will still be able to generate trophies by entering the API URL directly (as in, https://YOUR-DEPLOYMENT-ENDPOINT.vercel.app/?username=USERNAME)
• I don't know how much logging/activity data you get with a free account (probably not much), but you may wish to periodically check on the Logs tab for your deployment if the URL is exposed anywhere to make sure it's not being abused.
• If you're comfortable doing so, ryo-ma has invited people to share their endpoints publicly (see README) as a way of sharing the load. Totally up to you, just wanted to point that out. Let us know if you have any issues! Thanks for self-hosting!

[pylapp]

@kann4n @hesreallyhim Ok, thank you for your useful comments!

In a first step, I would like to know if I can "limit" the endpoint only for my selfish needs, just to be used to Vercel, and then see how I can share it.
Do you know if man can "limit" the use?

I am not used to this web tech, so sorry for this newbie question, where are these two parts in the repository (front and back I mean)?

[hesreallyhim]

@pylapp no problem, good on you for getting involved anyway.

When I mentioned the static site, I meant this page:

The code is actually just a HTML string in /api/index.ts lines 48:89, so it's in the same api file. if you want to limit the endpoint so that it only serves trophies for usernames that you select, yes it's possible - I'm a little reluctant to share the code here because I don't know if the maintainer would be happy about it or not (of course it's fine to do it on your own fork, I'm just talking about posting it here on this thread).

Unless your endpoint is being posted somewhere with high visibility, I would not worry too much about getting rate-limited so I guess my feeling is maybe give it a try and you can watch to see if anyone is using it (the logs will tell you) - but if you want, I have a 20-line patch to add a whitelist, so feel free to reach out to me - maybe you could even use my PGP inbox (!) (that would be really cool 😄 - no one has ever used it but i see you have a GPG key). Or my email is fine too.

Sorry, I'm not trying to be secretive I'm just cautious about posting modified code on this thread out of respect for ryo-ma's project.

[pylapp]

@hesreallyhim No problem I fully understand and agree! Thank you a lot, O sure your point of view.
I will take the time to look in the sources, discover Vercel, test the stuff, see how much it costs and if all lights are green share my endpoint 🤘

[soulteary]

Hey👋 @pylapp , If you do not pursue real-time data update and do not need self-deployment, you can use GitHub Action to achieve this. Maybe you can refer to the implementation of this repo file: https://github.com/soulteary/soulteary/blob/main/.github/workflows/cards.yml

the preview: https://github.com/soulteary/soulteary

see issue #404

[pylapp]

@soulteary Interesting! Indeed I do not need to have real time data, just to display things isolated sometimes. I will also have a look on that! Thank you 🙏