Skip to content

WizardCodeForge/pokemon-status

Repository files navigation

🐱‍👤 Pokemon-Stats API 🎮

Turn your GitHub metrics into XP for your favorite Pokémon! 🛡️⚔️

✨ About

Want to make your README even more epic and engaging? This API turns your GitHub contributions and metrics into a Pokémon journey, where every public commit, issue or pull request turns into experience (XP) for your chosen Pokémon! 🎉

Just add a few settings to your README, and your Pokémon will be there, evolving with each achievement on GitHub.

🚀 Como Funciona

  1. GitHub Metrics : The API extracts your activities from GitHub (commits, issues, PRs, etc.) and converts them into XP.
  2. XP Dynamic : Every metric counts towards your Pokémon's evolution!
  3. Total customization: Choose your favorite Pokémon and apply different themes.

🏋️‍♂️ Optional Arguments

  • user : GitHub username.
  • pokemon : The name of your favorite Pokémon (e.g. pikachu, charizard, bulbasaur).
  • theme : Customize the look of your Pokémon card with different themes.

🌟 Usage examples

https://pokemon-status.vercel.app/?user=CriticalNoob02&pokemon=charmander&theme=charmander

🛠️ How to use it in your README

Just add this custom URL to your README:

![Pokémon GitHub Stats](https://pokemon-status.vercel.app/?user=SEU_USUARIO&pokemon=SEU_POKEMON&theme=SEU_TEMA)

or if you prefer

<div align="center">
  <img src="https://pokemon-status.vercel.app/?user=SEU_USUARIO&pokemon=SEU_POKEMON&theme=SEU_TEMA">
</div>

Get creative, choose your favorite Pokémon and watch it grow as you contribute to open source! ⚡

🌟 Themes available

There is already a small variety of themes to use

Show themes...
  • charmander

Captura de tela de 2024-09-17 23-33-46

  • pikachu

Captura de tela de 2024-09-17 23-34-24

  • dratini

Captura de tela de 2024-09-17 23-34-38

  • bulbasaur

Captura de tela de 2024-09-17 23-34-50

  • ditto

Captura de tela de 2024-09-17 23-35-06

  • sylveon

Captura de tela de 2024-09-17 23-35-20

  • glaceon

Captura de tela de 2024-09-17 23-35-35

  • marshadow

Captura de tela de 2024-09-17 23-36-24

🚧 Outstanding

  • Implement support for Pokémon that evolve using items (e.g.: Eevee -> Vaporeon using a Water Stone ).
  • Improve the evolution logic for Pokémon with multiple evolutionary forms.
  • Add support for regional and alternative forms (e.g.: Alolan , Galarian ).
  • There is still no guarantee of compatibility with all browsers (it works perfectly in google chrome).

🔥 Future features

  • New themes and animated effects! 🎨
  • Adjustments to the weights of the github metrics! 📈

Contribute your knowledge to this project! 💻🎮

About

Adote um pokemon para seu README

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •