Skip to content

Commit 182215d

Browse files
authored
Initialize README.md with project details
Add detailed project description, features, and author info.
1 parent f33b475 commit 182215d

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# 🚀 GitHub Profile Viewer
2+
3+
A modern **GitHub profile viewer** that fetches real user data and repositories using the **GitHub REST API**, reimagined with a **futuristic glassmorphic UI**
4+
5+
Experience a next-gen GitHub look — minimal, interactive, and responsive.
6+
7+
---
8+
9+
## 🌐 Demo
10+
11+
🔗 **Live Preview:** [Guthib.surge.sh](https://guthib.surge.sh)
12+
💻 **Tech Stack:** HTML • CSS • JavaScript • GitHub API
13+
14+
---
15+
16+
## 🧩 Features
17+
18+
✅ Fetch any GitHub user's real-time profile data
19+
✅ Displays user avatar, name, bio, followers, and repositories
20+
✅ Interactive repo cards with hover animations
21+
✅ Fully responsive and futuristic **glassmorphism** design
22+
✅ API error handling for invalid usernames
23+
✅ Built with pure front-end — **no frameworks needed**
24+
25+
---
26+
27+
## 📸 Preview
28+
29+
> *A glimpse of the futuristic UI...*
30+
31+
<img width="1893" height="957" alt="image" src="https://github.com/user-attachments/assets/7d32ae82-6bff-46ac-854c-85a9007a8630" />
32+
33+
---
34+
35+
## ⚙️ How It Works
36+
37+
1. Enter any **GitHub username** in the search bar
38+
2. The app calls the official **GitHub REST API**
39+
3. Displays the user’s profile info and latest repositories instantly
40+
41+
---
42+
43+
## 🧠 Technologies Used
44+
45+
| Technology | Purpose |
46+
|-------------|----------|
47+
| **HTML5** | Structure and layout |
48+
| **CSS3** | Glassmorphism + modern UI |
49+
| **JavaScript (ES6)** | Fetch API + logic handling |
50+
| **GitHub REST API** | Live data integration |
51+
52+
---
53+
54+
## 🪄 Future Enhancements
55+
56+
🚧 Planned features for upcoming versions:
57+
- 🌙 Dark / Light mode toggle
58+
- 📊 Repository stats (stars, forks, language)
59+
- 🧠 Search history storage
60+
- 🔄 Lazy loading for large repo lists
61+
62+
---
63+
64+
## 👨‍💻 Author
65+
66+
**Menula De Silva**
67+
🌍 Developer | Designer | Student at St. Aloysius College, Ratnapura
68+
🔗 [Portfolio Website](https://dms-menula.github.io)
69+
🐙 [GitHub Profile](https://github.com/DMS-Menula)
70+
💼 [LinkedIn](https://www.linkedin.com/in/dmsmenula/)
71+
72+
---
73+
74+
## ⭐ Support the Project
75+
76+
If you like this project, please consider giving it a **⭐ star** — it helps more people discover it!
77+
78+
> “Small projects make big portfolios.” — *Menula De Silva*

0 commit comments

Comments
 (0)