kwakeunji / leetcode-badge-showcase Goto Github PK

LeetCode Badge Showcase

Showcase your LeetCode badges on your Github README page 🤩
✨ View Demo · 🐛 Report Bug · 💁🏽 Request Feature

Add the following line to your Github README.md 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)`

👉🏼 Image not rendering? Simply refresh the page!

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"/>

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

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

• Competitive: &filter=comp
• Daily Challenge: &filter=daily
• Study Plan: &filter=study

(back to top)

• 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

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)