Skip to content

KevzPeter/Leetcode-Badge-Showcase

Repository files navigation


Logo

LeetCode Badge Showcase

Showcase your LeetCode badges on your Github README page 🀩
✨ View Demo Β· πŸ› Report Bug Β· πŸ’πŸ½ Request Feature

πŸš€ Add to your README page


Add the following line to your Github README.md (or HTML) page and replace {your-leetcode-username} ‡️

<img src="https://leetcode-badge-showcase.vercel.app/api?username={your-leetcode-username}" alt="LeetCode Badges"/>

Or even this way ‡️

![LeetCode Badges](https://leetcode-badge-showcase.vercel.app/api?username={your-leetcode-username})

For example, if your Leetcode username is "kevzpeter", add the following line:

![LeetCode Badges](https://leetcode-badge-showcase.vercel.app/api?username=kevzpeter&animated=true)

πŸ‘‰πŸΌ Image not rendering? Simply refresh the page!

✨ Animated Badges

To animate your badges in the showcase, add the parameter animated to the url and set its value to true:

<img src="https://leetcode-badge-showcase.vercel.app/api?username={your-leetcode-username}&animated=true" alt="LeetCode Badges"/>

Example

LeetCode Badges

🎨 Themes

Want to spice up the look and feel of your badge showcase? You can choose your favorite among 16 different themes!

Simply add the theme parameter to the url like so:

<img src="https://leetcode-badge-showcase.vercel.app/api?username={your-leetcode-username}&theme={your-theme}" alt="LeetCode Badges"/>

Examples

light
light
dark
dark
github-dark
github-dark
monokai
monokai
tokyonight
tokyonight
nightowl
nightowl
onedark
onedark
shades-of-purple
shades-of-purple
dracula
dracula
cobalt2
cobalt2
sky
sky
beach
beach
purple-gang
purple-gang
mint
mint
leafy
leafy
black
black

βœ‚οΈ Filters

Wanna only show a specific set of badges ? Add a filter parameter like so :

<img src="https://leetcode-badge-showcase.vercel.app/api?username={your-leetcode-username}&filter={your-filter}" alt="LeetCode Badges"/>
  • Competitive Badges: &filter=comp
  • Daily Challenge: &filter=daily
  • Study Plan: &filter=study

πŸ”§ Built With


  • Next
  • React

πŸ—οΈ Set Up your own Server

  • Make sure you have Node.js installed
  • Clone the repository
  • Run npm i in the root directory
  • Run npm run dev to make sure everything's working fine
  • Replace BASEURL in utils/config.ts to the deployment url of your choice
  • Deploy to Vercel with the same deployment url
  • Head over to https://{your-vercel-deployment-url}/api?username={your-leetcode-username} to view the results
  • Oh, and make sure to update the links in your README file as well :P

πŸ™ŒπŸΌ Contributing

If you wanna add your custom theme or suggest enhancements, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)