منصوبے کے بارے میں

یہ ریپوزٹری Shields.io کا گھر ہے، جو SVG اور راسٹر فارمیٹ میں مختصر، مستقل اور قابل مطالعہ بیجز فراہم کرنے والی سروس ہے۔ README کے مطابق بیجز کو GitHub ریڈمی یا کسی بھی دوسرے ویب صفحے میں شامل کیا جا سکتا ہے۔ یہ بتاتا ہے کہ سروس درجنوں مسلسل انضمام (CI) خدمات، پیکیج رجسٹری، تقسیم، ایپ اسٹورز، سوشل نیٹ ورکس، کوڈ کوریج خدمات اور کوڈ تجزیہ خدمات کو سپورٹ کرتی ہے۔ ہر ماہ یہ 1.6 بلین سے زیادہ تصاویر پیش کرتی ہے اور اسے VS Code، Vue.js اور Bootstrap جیسے منصوبے استعمال کرتے ہیں۔ اس ریپوزٹری میں Shields.io کا فرنٹ اینڈ اور سرور کوڈ، بیجز بنانے کے لیے ایک NPM لائبریری جسے badge-maker کہتے ہیں، اور بیج ڈیزائن کی تفصیلات موجود ہیں۔ درج کردہ مثالوں میں کوڈ کوریج کا فیصد، مستحکم ریلیز ورژن، پیکیج مینیجر ریلیز، انحصار کی حیثیت، جامد کوڈ تجزیہ کا درجہ، SemVer ورژن، ہفتہ وار Liberapay عطیات، Python پیکیج ڈاؤن لوڈ، Chrome Web Store ایکسٹینشن کی درجہ بندی اور Uptime Robot کا اپ ٹائم فیصد شامل ہیں۔ صارفین URL پیٹرن کے ساتھ اپنی مرضی کے بیجز بنا سکتے ہیں۔ README میں ایک فوری آغاز بیان کیا گیا ہے جہاں صارفین بیجز کی مکمل فہرست دیکھ سکتے ہیں، زمرہ جات تلاش یا براؤز کر سکتے ہیں، ایک بیج پر کلک کر کے مطلوبہ ڈیٹا جیسے صارف نام یا ریپو بھر سکتے ہیں، اختیاری طور پر لیبل اور رنگ تبدیل کر سکتے ہیں، اور پھر بیج کا URL یا کوڈ GitHub ریڈمی یا دیگر ویب صفحات کے لیے کاپی کر سکتے ہیں۔ شراکت کمیونٹی پر مبنی ہے اور مسائل اور پل ریکویسٹ کے ذریعے ہوتی ہے؛ README شراکت داروں سے کہتا ہے کہ جب کوئی سروس شامل یا تبدیل کریں تو ٹیسٹ شامل کریں، اور بیج شامل کرنے کے لیے ایک ٹیوٹوریل کی طرف اشارہ کرتا ہے۔ یہ اچھے پہلے مسائل اور سیکیورٹی پالیسی کا بھی حوالہ دیتا ہے۔ ترقی کے لیے، README Node 24 انسٹال کرنے، ریپوزٹری کلون کرنے، npm ci چلانے، npm start چلانے اور localhost:3000 کھولنے کی فہرست دیتا ہے۔ سرور کے سورس میں تبدیلیاں nodemon کے ذریعے دوبارہ شروع ہوتی ہیں، جبکہ فرنٹ اینڈ تبدیلیاں Docusaurus ڈیو سرور کے ذریعے لوڈ ہوتی ہیں؛ بیج کی تعریفیں پہلے سرور شروع ہونے سے پہلے بنائی جاتی ہیں اور npm run prestart یا دوبارہ شروع کرنے سے دوبارہ تیار کی جا سکتی ہیں۔ ایک بیج کو کمانڈ لائن سے npm run badge کے ساتھ ڈیبگ کیا جا سکتا ہے، بشمول مکمل URLs۔ سنیپ شاٹ ٹیسٹ SVG یا JSON آؤٹ پٹ کی حفاظت کرتے ہیں؛ جان بوجھ کر آؤٹ پٹ تبدیلیوں کا پیش نظارہ SNAPSHOT_DRY=1 npm run test:package سے کیا جا سکتا ہے اور SNAPSHOT_UPDATE=1 سے اپ ڈیٹ کیا جا سکتا ہے۔ سرور اختیاری طور پر Sentry اور Prometheus استعمال کر سکتا ہے۔ خود میزبانی کی دستاویزات سے منسلک ہے۔ متعلقہ منصوبوں میں awesome-badges شامل ہے، جو ایک منتخب مجموعہ ہے۔ README تاریخ دیتا ہے: b.adge.me اصل سائٹ تھی، جو 2013 کے gh-badges کوڈ سے بنی تھی؛ یہ منصوبہ shields.io کے ساتھ ضم ہو گیا۔ اصل بیج کی تفصیلات 2013 میں تیار کی گئیں اور بعد میں 2014 میں دوبارہ ڈیزائن کی گئیں؛ پرانے ڈیزائن کو پلاسٹک اسٹائل اور نئے کو فلیٹ اسٹائل کہتے ہیں۔ منتظمین اور سابق طلباء کی فہرست دی گئی ہے، اور یہ منصوبہ MIT اور Apache 2.0 کے تحت دوہری لائسنس یافتہ ہے۔ یہ کمیونٹی فنڈنگ اور سپورٹ سے بھی منسلک ہے۔