Skip to content

Commit ff41a6c

Browse files
committed
docs: add UI screenshots to README
1 parent d682cef commit ff41a6c

3 files changed

Lines changed: 60 additions & 52 deletions

File tree

README.md

Lines changed: 60 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# 🚀 DevImpact
2+
23
![License](https://img.shields.io/github/license/o2sa/devimpact)
34
![Stars](https://img.shields.io/github/stars/o2sa/devimpact)
45
![Forks](https://img.shields.io/github/forks/o2sa/devimpact)
@@ -11,14 +12,13 @@
1112
![Node.js](https://img.shields.io/badge/Node.js-green?logo=node.js)
1213
![GraphQL](https://img.shields.io/badge/GraphQL-pink?logo=graphql)
1314

14-
1515
**DevImpact** is an open-source platform that compares software developers based on their real impact in the open-source ecosystem — not just raw numbers.
1616

1717
It evaluates developers using a smart scoring system that considers:
1818

19-
* Repository quality 📦
20-
* Pull request impact 🔀
21-
* Community contributions 💬
19+
- Repository quality 📦
20+
- Pull request impact 🔀
21+
- Community contributions 💬
2222

2323
---
2424

@@ -28,9 +28,9 @@ Traditional metrics (followers, stars, commit counts) are often misleading.
2828

2929
DevImpact focuses on:
3030

31-
* ✅ Quality over quantity
32-
* ✅ Real contributions to valuable projects
33-
* ✅ Fair comparison between developers
31+
- ✅ Quality over quantity
32+
- ✅ Real contributions to valuable projects
33+
- ✅ Fair comparison between developers
3434

3535
---
3636

@@ -44,9 +44,9 @@ Measures the quality and impact of repositories owned by the user.
4444

4545
Factors include:
4646

47-
* Stars ⭐
48-
* Forks 🍴
49-
* Watchers
47+
- Stars ⭐
48+
- Forks 🍴
49+
- Watchers
5050

5151
---
5252

@@ -59,10 +59,10 @@ Measures contributions to **other developers' repositories**.
5959

6060
Factors include:
6161

62-
* Target repository quality
63-
* PR size (additions/deletions)
64-
* Repository popularity
65-
* Contribution diversity
62+
- Target repository quality
63+
- PR size (additions/deletions)
64+
- Repository popularity
65+
- Contribution diversity
6666

6767
---
6868

@@ -72,8 +72,8 @@ Measures community engagement.
7272

7373
Includes:
7474

75-
* Issues opened in external repositories
76-
* Discussions participation
75+
- Issues opened in external repositories
76+
- Discussions participation
7777

7878
⚠️ Does NOT include commits or PRs (to avoid duplication)
7979

@@ -96,43 +96,52 @@ Final Score =
9696

9797
## ⚖️ Key Design Principles
9898

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
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
103103

104104
---
105105

106106
## 🖥️ Features
107107

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
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
114114

115115
---
116116

117-
## 🛠️ Tech Stack
117+
## 📸 Screenshots
118118

119-
### Frontend
119+
### 🖥️ Desktop View
120120

121-
* Next.js (App Router)
122-
* TypeScript
123-
* Tailwind CSS
124-
* Recharts
121+
![Desktop](./public/screenshots/desktop.png)
125122

126-
### API
123+
### 📱 Mobile View
127124

128-
* Node.js + Express
129-
* GitHub GraphQL API
130-
* Octokit
125+
![Mobile](./public/screenshots/mobile.png)
131126

132127
---
133128

129+
## 🛠️ Tech Stack
134130

131+
### Frontend
135132

133+
- Next.js (App Router)
134+
- TypeScript
135+
- Tailwind CSS
136+
- Recharts
137+
138+
### API
139+
140+
- Node.js + Express
141+
- GitHub GraphQL API
142+
- Octokit
143+
144+
---
136145

137146
## 🚀 Getting Started
138147

@@ -206,12 +215,13 @@ curl "api/compare?username=devimpact&username=octocat"
206215

207216
## 🌍 Localization
208217

209-
* Supported languages: English 🇺🇸, Arabic 🇸🇦
210-
* Automatically detects user language
211-
* Allows manual switching
212-
* Easy to add new languages via `/locales`
218+
- Supported languages: English 🇺🇸, Arabic 🇸🇦
219+
- Automatically detects user language
220+
- Allows manual switching
221+
- Easy to add new languages via `/locales`
213222

214223
---
224+
215225
## 🤝 Contributing
216226

217227
Contributions are welcome!
@@ -227,22 +237,21 @@ Contributions are welcome!
227237

228238
### Contribution ideas:
229239

230-
* Improve scoring algorithm
231-
* Add new metrics
232-
* Enhance UI/UX
233-
* Add new languages 🌍
240+
- Improve scoring algorithm
241+
- Add new metrics
242+
- Enhance UI/UX
243+
- Add new languages 🌍
234244

235245
---
236246

237247
## ⚠️ Limitations
238248

239-
* GitHub API rate limits
240-
* Some private contributions are not accessible
241-
* Scoring system is heuristic (not perfect)
249+
- GitHub API rate limits
250+
- Some private contributions are not accessible
251+
- Scoring system is heuristic (not perfect)
242252

243253
---
244254

245-
246255
## 💡 Inspiration
247256

248257
DevImpact was created to answer a simple question:
@@ -255,7 +264,6 @@ DevImpact was created to answer a simple question:
255264

256265
If you like this project:
257266

258-
* ⭐ Star the repo
259-
* 🐛 Report issues
260-
* 💡 Suggest features
261-
267+
- ⭐ Star the repo
268+
- 🐛 Report issues
269+
- 💡 Suggest features

public/screenshots/desktop.png

1.66 MB
Loading

public/screenshots/mobile.png

2.13 MB
Loading

0 commit comments

Comments
 (0)