Skip to content

ful1e5/sponsor-spotlight

Repository files navigation

sponsor-spotlight

This project would like to extend a warm shoutout to our fantastic Github monthly sponsors. Approximately 70% of requests will feature a randomly selected sponsor, with the remaining being utilized for onboarding new sponsors.

Usage

Simply use the image endpoint https://sponsor-spotlight.vercel.app/sponsor and append your GitHub Sponsor program-eligible username as the login query parameter. For example:

![shoutout-sponsors](https://sponsor-spotlight.vercel.app/sponsor?login=ful1e5)

This will display a "Shoutout" image for a random sponsor with every request.

Sponsor

In some instances, you may receive a message for onboarding new sponsors.

Request

If you have not joined the GitHub Sponsorship program or if your GitHub username cannot be found, the following will appear:

Error

Development

Images are generated by a React component and is embedded within an SVG. You can run the project locally using the Vercel CLI by running the following command in your terminal:

vercel dev

And also require Github personal access token (classic) with read:org and read:user permissions because it is necessary to access Github graphql API and assigned with GH_AUTH_TOKEN NodeJS environment variable. Read more on GitHub Docs

# .env
GH_AUTH_TOKEN=<token>
TODOs
  • Share with the internet.
  • Onboard 20 standard-tier sponsors.
  • Design a Shout Out Octocat Icon.
  • Use styled-components
  • Write better messages
  • Write tests.
  • Purchase a domain.
  • Transform this into a website with added customization.
Assets

All of the hand-designed assets are available on Figma, including Octocat icons in a convenient resolution with SVG format.

Blog posts
  • About Sponsor Spotlight on dev.to