Skip to content

Commit 827e0a5

Browse files
committed
Merge branch 'main' of https://github.com/O2sa/DevImpact
2 parents 5d72497 + a7918f6 commit 827e0a5

1 file changed

Lines changed: 230 additions & 1 deletion

File tree

README.md

Lines changed: 230 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,230 @@
1-
# DevImpact
1+
# 🚀 DevImpact
2+
![License](https://img.shields.io/github/license/o2sa/devimpact)
3+
![Stars](https://img.shields.io/github/stars/o2sa/devimpact)
4+
![Forks](https://img.shields.io/github/forks/o2sa/devimpact)
5+
![Issues](https://img.shields.io/github/issues/o2sa/devimpact)
6+
![Pull Requests](https://img.shields.io/github/issues-pr/o2sa/devimpact)
7+
![Last Commit](https://img.shields.io/github/last-commit/o2sa/devimpact)
8+
9+
![Next.js](https://img.shields.io/badge/Next.js-16+-black?logo=next.js)
10+
![TypeScript](https://img.shields.io/badge/TypeScript-blue?logo=typescript)
11+
![Node.js](https://img.shields.io/badge/Node.js-green?logo=node.js)
12+
![GraphQL](https://img.shields.io/badge/GraphQL-pink?logo=graphql)
13+
14+
15+
**DevImpact** is an open-source platform that compares software developers based on their real impact in the open-source ecosystem — not just raw numbers.
16+
17+
It evaluates developers using a smart scoring system that considers:
18+
19+
* Repository quality 📦
20+
* Pull request impact 🔀
21+
* Community contributions 💬
22+
23+
---
24+
25+
## 🌟 Why DevImpact?
26+
27+
Traditional metrics (followers, stars, commit counts) are often misleading.
28+
29+
DevImpact focuses on:
30+
31+
* ✅ Quality over quantity
32+
* ✅ Real contributions to valuable projects
33+
* ✅ Fair comparison between developers
34+
35+
---
36+
37+
## 🧠 Scoring System Overview
38+
39+
Each developer is evaluated using three main scores:
40+
41+
### 📦 Repo Score (Builder Impact)
42+
43+
Measures the quality and impact of repositories owned by the user.
44+
45+
Factors include:
46+
47+
* Stars ⭐
48+
* Forks 🍴
49+
* Watchers
50+
51+
---
52+
53+
### 🔀 PR Score (Contribution Impact)
54+
55+
Measures contributions to **other developers' repositories**.
56+
57+
✔ Only merged PRs are counted
58+
✔ PRs to user's own repositories are excluded
59+
60+
Factors include:
61+
62+
* Target repository quality
63+
* PR size (additions/deletions)
64+
* Repository popularity
65+
* Contribution diversity
66+
67+
---
68+
69+
### 💬 Contribution Score (Community Impact)
70+
71+
Measures community engagement.
72+
73+
Includes:
74+
75+
* Issues opened in external repositories
76+
* Discussions participation
77+
78+
⚠️ Does NOT include commits or PRs (to avoid duplication)
79+
80+
---
81+
82+
### 🏆 Final Score
83+
84+
The final score is a weighted combination:
85+
86+
```
87+
Final Score =
88+
0.45 × Repo Score +
89+
0.45 × PR Score +
90+
0.10 × Contribution Score
91+
```
92+
93+
👉 ContributionScore is capped to prevent abuse.
94+
95+
---
96+
97+
## ⚖️ Key Design Principles
98+
99+
* ❌ No self-inflation (own PRs excluded)
100+
* 📉 Diminishing returns to prevent spam
101+
* 🎯 External impact is prioritized
102+
* ⚖️ Balanced scoring between builders and contributors
103+
104+
---
105+
106+
## 🖥️ Features
107+
108+
* 🔍 Compare two GitHub users side-by-side
109+
* 📊 Visual score breakdown (charts & insights)
110+
* 🧠 Smart ranking system
111+
* 🌍 Localization support (EN / AR)
112+
* ⚡ Fast API powered by GitHub GraphQL
113+
* 🧩 Extensible scoring system
114+
115+
---
116+
117+
## 🛠️ Tech Stack
118+
119+
### Frontend
120+
121+
* Next.js (App Router)
122+
* TypeScript
123+
* Tailwind CSS
124+
* Recharts
125+
126+
### Api
127+
128+
* Node.js + Express
129+
* GitHub GraphQL API
130+
* Octokit
131+
132+
---
133+
134+
135+
136+
137+
## 🚀 Getting Started
138+
139+
### 1. Clone the repo
140+
141+
```bash
142+
git clone https://github.com/your-username/devimpact.git
143+
cd devimpact
144+
```
145+
146+
---
147+
148+
### 2. Install dependencies
149+
150+
```bash
151+
pnpm install
152+
```
153+
154+
---
155+
156+
### 3. Setup environment variables
157+
158+
Create a `.env` file:
159+
160+
```
161+
GITHUB_TOKEN=your_github_token
162+
```
163+
164+
---
165+
166+
### 4. Run the app
167+
168+
```bash
169+
pnpm run dev
170+
```
171+
172+
---
173+
174+
## 🌍 Localization
175+
176+
* Supported languages: English 🇺🇸, Arabic 🇸🇦
177+
* Automatically detects user language
178+
* Allows manual switching
179+
* Easy to add new languages via `/locales`
180+
181+
---
182+
183+
184+
## 🤝 Contributing
185+
186+
Contributions are welcome!
187+
188+
### How to contribute:
189+
190+
1. Fork the repository
191+
2. Create a feature branch
192+
3. Commit your changes
193+
4. Open a pull request
194+
195+
---
196+
197+
### Contribution ideas:
198+
199+
* Improve scoring algorithm
200+
* Add new metrics
201+
* Enhance UI/UX
202+
* Add new languages 🌍
203+
204+
---
205+
206+
## ⚠️ Limitations
207+
208+
* GitHub API rate limits
209+
* Some private contributions are not accessible
210+
* Scoring system is heuristic (not perfect)
211+
212+
---
213+
214+
215+
## 💡 Inspiration
216+
217+
DevImpact was created to answer a simple question:
218+
219+
> “Who really has more impact in open-source?”
220+
221+
---
222+
223+
## ⭐ Support
224+
225+
If you like this project:
226+
227+
* ⭐ Star the repo
228+
* 🐛 Report issues
229+
* 💡 Suggest features
230+

0 commit comments

Comments
 (0)