https://github.com/isaka-james/top
🏆 Add dynamically generated rank of yours Nationwide, according to GitHub to your README
https://github.com/isaka-james/top
badges flask github-statistics nation-wide national
Last synced: 10 months ago
JSON representation
🏆 Add dynamically generated rank of yours Nationwide, according to GitHub to your README
- Host: GitHub
- URL: https://github.com/isaka-james/top
- Owner: isaka-james
- License: mit
- Created: 2024-02-26T23:42:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T23:21:54.000Z (over 1 year ago)
- Last Synced: 2025-01-26T16:47:31.158Z (12 months ago)
- Topics: badges, flask, github-statistics, nation-wide, national
- Language: Python
- Homepage: https://toppers-nation.vercel.app
- Size: 386 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🚀 Toppers Nationwide 🏆
Get your badge showing your current nationwide position realtime from GitHub.
# Quick Start
Add the following code to your readme. When pasting the code into your profile's
readme, change the `?name=` value, and the `&country=` value to your GitHub's username and your country name respectively.
```
[](https://github.com/isaka-james/top)
```
## ℹ️ About
Toppers Nation is an API-driven web application that generates badges displaying a user's position in the nation according to their GitHub statistics. Users can simply input their GitHub username and country and receive a badge showcasing their position among other developers nationwide.
## ✨ Features
- **Badge Generation**: Quickly generate badges indicating a user's position in the nation based on GitHub statistics.
- **User-Friendly Interface**: Simple and intuitive user interface for ease of use.
- **Real-Time Data**: Utilizes real-time GitHub statistics to provide accurate positioning information.
- **Fast** : Tested it brings the trophy very fast even in slow internet connections.
### Sample 🦁
Let use this guy as example, [@adamwreuben](https://github.com/adamwreuben) , He is at the first position since 2019.
The readme code:
```bash
[](https://github.com/isaka-james/top)
```
## 📝 Furthermore:
To utilize this API, you will need to provide two pieces of information:
- Your GitHub username
- The name of your country
For example my username🤵♂️ is **isaka-james** and my country🇹🇿 is **Tanzania**, so I put this to my README:
```
[](https://github.com/isaka-james/top)
```
So the trophy will come like this:
Please ensure that the name of your country is entered without spaces or uppercase letters. Below is the complete list of countries, each formatted accordingly:
| afghanistan | albania | algeria |
|------------------|------------------|----------------|
| angola | argentina | armenia |
| australia | austria | azerbaijan |
| bahrain | bangladesh | belarus |
| belgium | benin | bolivia |
| botswana | brazil | bulgaria |
| burkina_faso | burundi | cambodia |
| cameroon | canada | chad |
| chile | china | colombia |
| congo_brazzaville| congo_kinshasa | croatia |
| cuba | cyprus | czech_republic |
| denmark | dominican_republic| ecuador |
| egypt | el_salvador | estonia |
| ethiopia | finland | france |
| gabon | germany | ghana |
| greece | guatemala | guinea |
| haiti | honduras | hong_kong |
| hungary | india | indonesia |
| iran | iraq | ireland |
| israel | italy | ivory_coast |
| japan | jordan | kazakhstan |
| kenya | kyrgyzstan | laos |
| latvia | lebanon | libya |
| lithuania | luxembourg | macau |
| macedonia | malawi | malaysia |
| mali | malta | mauritania |
| mexico | moldova | morocco |
| mozambique | myanmar | nepal |
| netherlands | new_zealand | nicaragua |
| niger | nigeria | norway |
| oman | pakistan | palestine |
| panama | papua_new_guinea | paraguay |
| peru | philippines | poland |
| portugal | qatar | romania |
| russia | rwanda | saudi_arabia |
| senegal | serbia | sierra_leone |
| singapore | slovakia | slovenia |
| somalia | south_africa | republic_of_korea|
| south_sudan | spain | sri_lanka |
| sudan | sweden | switzerland |
| syria | taiwan | tajikistan |
| tanzania | thailand | the_bahamas |
| togo | tunisia | turkey |
| turkmenistan | uae | uganda |
| uk | ukraine | united_states |
| uruguay | uzbekistan | venezuela |
| vietnam | worldwide | yemen |
| zambia | zimbabwe | |
## Badges which are present rightnow:
I used the millitary badge from the **USA**, after calculating your position then the badge come automatically.. Here are the sample badges; Also if you see that you can add something then you are warmly welcomed to the contribution:
Their readme code:
```html
[](https://github.com/isaka-james/top)
[](https://github.com/isaka-james/top)
[](https://github.com/isaka-james/top)
[](https://github.com/isaka-james/top)
[](https://github.com/isaka-james/top)
[](https://github.com/isaka-james/top)
[](https://github.com/isaka-james/top)
```
## 🛠️ Technologies Used
- Frontend: svg
- Backend: Flask, commiters.top, github
- Deployment: Vercel
## 🤝 Contributing
Contributions are welcome! If you have any ideas for improvements or new features, feel free to open an issue or submit a pull request.
## 📄 License
This project is licensed under the [MIT License](LICENSE).