diff --git a/README.md b/README.md index e15defa..2beca0f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # πŸš€ DevImpact + ![License](https://img.shields.io/github/license/o2sa/devimpact) ![Stars](https://img.shields.io/github/stars/o2sa/devimpact) ![Forks](https://img.shields.io/github/forks/o2sa/devimpact) @@ -11,14 +12,13 @@ ![Node.js](https://img.shields.io/badge/Node.js-green?logo=node.js) ![GraphQL](https://img.shields.io/badge/GraphQL-pink?logo=graphql) - **DevImpact** is an open-source platform that compares software developers based on their real impact in the open-source ecosystem β€” not just raw numbers. It evaluates developers using a smart scoring system that considers: -* Repository quality πŸ“¦ -* Pull request impact πŸ”€ -* Community contributions πŸ’¬ +- Repository quality πŸ“¦ +- Pull request impact πŸ”€ +- Community contributions πŸ’¬ --- @@ -28,9 +28,9 @@ Traditional metrics (followers, stars, commit counts) are often misleading. DevImpact focuses on: -* βœ… Quality over quantity -* βœ… Real contributions to valuable projects -* βœ… Fair comparison between developers +- βœ… Quality over quantity +- βœ… Real contributions to valuable projects +- βœ… Fair comparison between developers --- @@ -44,9 +44,9 @@ Measures the quality and impact of repositories owned by the user. Factors include: -* Stars ⭐ -* Forks 🍴 -* Watchers +- Stars ⭐ +- Forks 🍴 +- Watchers --- @@ -59,10 +59,10 @@ Measures contributions to **other developers' repositories**. Factors include: -* Target repository quality -* PR size (additions/deletions) -* Repository popularity -* Contribution diversity +- Target repository quality +- PR size (additions/deletions) +- Repository popularity +- Contribution diversity --- @@ -72,8 +72,8 @@ Measures community engagement. Includes: -* Issues opened in external repositories -* Discussions participation +- Issues opened in external repositories +- Discussions participation ⚠️ Does NOT include commits or PRs (to avoid duplication) @@ -96,43 +96,52 @@ Final Score = ## βš–οΈ Key Design Principles -* ❌ No self-inflation (own PRs excluded) -* πŸ“‰ Diminishing returns to prevent spam -* 🎯 External impact is prioritized -* βš–οΈ Balanced scoring between builders and contributors +- ❌ No self-inflation (own PRs excluded) +- πŸ“‰ Diminishing returns to prevent spam +- 🎯 External impact is prioritized +- βš–οΈ Balanced scoring between builders and contributors --- ## πŸ–₯️ Features -* πŸ” Compare two GitHub users side-by-side -* πŸ“Š Visual score breakdown (charts & insights) -* 🧠 Smart ranking system -* 🌍 Localization support (EN / AR) -* ⚑ Fast API powered by GitHub GraphQL -* 🧩 Extensible scoring system +- πŸ” Compare two GitHub users side-by-side +- πŸ“Š Visual score breakdown (charts & insights) +- 🧠 Smart ranking system +- 🌍 Localization support (EN / AR) +- ⚑ Fast API powered by GitHub GraphQL +- 🧩 Extensible scoring system --- -## πŸ› οΈ Tech Stack +## πŸ“Έ Screenshots -### Frontend +### πŸ–₯️ Desktop View -* Next.js (App Router) -* TypeScript -* Tailwind CSS -* Recharts +Desktop View -### API +### πŸ“± Mobile View -* Node.js + Express -* GitHub GraphQL API -* Octokit +Mobile View --- +## πŸ› οΈ Tech Stack +### Frontend +- Next.js (App Router) +- TypeScript +- Tailwind CSS +- Recharts + +### API + +- Node.js + Express +- GitHub GraphQL API +- Octokit + +--- ## πŸš€ Getting Started @@ -206,12 +215,13 @@ curl "api/compare?username=devimpact&username=octocat" ## 🌍 Localization -* Supported languages: English πŸ‡ΊπŸ‡Έ, Arabic πŸ‡ΈπŸ‡¦ -* Automatically detects user language -* Allows manual switching -* Easy to add new languages via `/locales` +- Supported languages: English πŸ‡ΊπŸ‡Έ, Arabic πŸ‡ΈπŸ‡¦ +- Automatically detects user language +- Allows manual switching +- Easy to add new languages via `/locales` --- + ## 🀝 Contributing Contributions are welcome! @@ -227,22 +237,21 @@ Contributions are welcome! ### Contribution ideas: -* Improve scoring algorithm -* Add new metrics -* Enhance UI/UX -* Add new languages 🌍 +- Improve scoring algorithm +- Add new metrics +- Enhance UI/UX +- Add new languages 🌍 --- ## ⚠️ Limitations -* GitHub API rate limits -* Some private contributions are not accessible -* Scoring system is heuristic (not perfect) +- GitHub API rate limits +- Some private contributions are not accessible +- Scoring system is heuristic (not perfect) --- - ## πŸ’‘ Inspiration DevImpact was created to answer a simple question: @@ -255,7 +264,6 @@ DevImpact was created to answer a simple question: If you like this project: -* ⭐ Star the repo -* πŸ› Report issues -* πŸ’‘ Suggest features - +- ⭐ Star the repo +- πŸ› Report issues +- πŸ’‘ Suggest features diff --git a/public/screenshots/desktop.png b/public/screenshots/desktop.png new file mode 100644 index 0000000..7751ba3 Binary files /dev/null and b/public/screenshots/desktop.png differ diff --git a/public/screenshots/mobile.png b/public/screenshots/mobile.png new file mode 100644 index 0000000..a4ed916 Binary files /dev/null and b/public/screenshots/mobile.png differ