LuciNyan / pixel-profile

Generate a pixel art style profile card from your GitHub data! ✨

Home Page:https://pixel-profile.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add info on required env vars

transitive-bullshit opened this issue · comments

Cool project – really love the approach!

It looks like the PAT_1 env var is required in order to run the api locally or on vercel. Otherwise, you'll get a blank image resulting from a "No GitHub API tokens found" error. Prolly would be a good idea to support a cleaner env var name like GITHUB_API_TOKEN or something.

I had to generate a new github personal auth token w/ read user scope in order to get it to work.

Maybe consider using dotenv-safe with a .env.example file to throw an error right away if missing env vars instead of throwing a 500 at the api level?

Cheers && thanks 🙏

Here's my profile from my deployed version:

github stats

Thank you for the feedback! 🙏 I really appreciate you taking the time to suggest improvements! 🚀🚀🚀

Updated readme looks great :)