इस प्रोजेक्ट के बारे में
GitHub Languages Card एक Node.js/Express वेब सेवा है जो GitHub उपयोगकर्ता की सबसे अधिक उपयोग की जाने वाली प्रोग्रामिंग भाषाओं को दिखाने वाले SVG कार्ड बनाती है, जिसे प्रोफ़ाइल README, पोर्टफोलियो और दस्तावेज़ों में एम्बेड करने के लिए डिज़ाइन किया गया है। एक होस्टेड डेमो github-languages-card.vercel.app पर उपलब्ध है, और परियोजना को स्व-होस्ट भी किया जा सकता है।
मुख्य कार्यक्षमता: एंडपॉइंट GET /api/top-languages एक आवश्यक username पैरामीटर और एक वैकल्पिक theme पैरामीटर (डिफ़ॉल्ट pink) स्वीकार करता है, जो एक SVG छवि लौटाता है जिसे सीधे Markdown में एम्बेड किया जा सकता है। कार्ड प्रतिशत के साथ शीर्ष भाषाएं, साथ ही रिपॉजिटरी, फॉलोअर्स, स्टार्स और फोर्क्स जैसे GitHub आँकड़े, और वैकल्पिक रूप से उपयोगकर्ता का अवतार प्रदर्शित करता है। README में कहा गया है कि कोई डेटा संग्रहीत नहीं किया जाता है और अनुरोध सीधे GitHub API पर जाते हैं।
थीम: README में 18+ नामित थीम सूचीबद्ध हैं, जिनमें pink, dark, mint, purple, ocean, sunset, graphite, coffee, lavender, peach, neon, strawberry, darkNeon, fire, snow, hacker, white और golden शामिल हैं। README थीम की एक रैंक की गई "शीर्ष पसंद" सूची प्रस्तुत करता है, जो लेखक की स्वयं की प्रस्तुति है, न कि एक स्वतंत्र मूल्यांकन।
स्व-होस्टिंग: Node.js 18+ और npm/yarn की आवश्यकता है। चरण हैं: रिपॉजिटरी क्लोन करना, npm install चलाना, .env.example को .env में कॉपी करना, और node server.js के साथ शुरू करना, जिसके बाद ऐप localhost:3000 पर उपलब्ध होता है। node:18-alpine पर आधारित एक नमूना Dockerfile प्रदान किया गया है। पर्यावरण चर में PORT (डिफ़ॉल्ट 3000), GITHUB_TOKEN (वैकल्पिक, उच्च API दर सीमा के लिए), NODE_ENV और RENDER_EXTERNAL_URL शामिल हैं।
परियोजना संरचना: server.js मुख्य Express सर्वर है; public/ लैंडिंग पृष्ठ और दस्तावेज़ छवियों को रखता है; utils/ में github.js (GitHub API एकीकरण), svgBuilder.js (SVG कार्ड बिल्डर) और helpers.js शामिल हैं; themes/ में प्रति-थीम परिभाषाएँ हैं। बताई गई तकनीकी स्टैक Node.js, Express, Axios और SVG जनरेशन है।
लेखकों द्वारा नोट की गई ज्ञात सीमाएँ: GitHub API दर-सीमित है (बिना टोकन के 60 अनुरोध/घंटा, GITHUB_TOKEN के साथ 5000/घंटा), और GitHub API प्रतिक्रिया समय के कारण पहला अनुरोध धीमा हो सकता है। परियोजना MIT लाइसेंस प्राप्त है और फोर्क/ब्रांच/पुल-रिक्वेस्ट वर्कफ़्लो के माध्यम से योगदान का स्वागत करती है। README यह भी नोट करता है कि प्रतिबंधित क्षेत्रों के उपयोगकर्ताओं को Vercel-होस्टेड डेमो तक पहुँचने के लिए VPN की आवश्यकता हो सकती है।
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.