প্রকল্প সম্পর্কে

এই রিপোজিটরি হল Shields.io-এর মূল বাসস্থান, এটি SVG ও রাস্টার ফরম্যাটে সংক্ষিপ্ত, সামঞ্জস্যপূর্ণ ও পাঠযোগ্য ব্যাজের জন্য একটি সেবা। README-তে বলা হয়েছে যে এই ব্যাজগুলো GitHub রিডমেস বা যেকোনো অন্যান্য ওয়েব পেজে এম্বেড করা যায়। এটি উল্লেখ করে যে এই সেবা দশের ওপর CI, প্যাকেজ রেজিস্ট্রি, ডিস্ট্রিবিউশন, অ্যাপ স্টোর, সোশ্যাল নেটওয়ার্ক, কোড কভারেজ সেবা ও কোড অ্যানালাইসিস সেবা সমর্থন করে। এটি বলে যে প্রতি মাসে এটি ১.৬ বিলিয়নেরও বেশি ছবি পরিবহন করে এবং VS Code, Vue.js ও Bootstrap-এর মতো প্রকল্পগুলো এটিকে ব্যবহার করে। রিপোজিটরিতে Shields.io-এর ফ্রন্টএন্ড ও সার্ভার কোড, ব্যাজ তৈরি করার জন্য badge-maker নামের একটি NPM লাইব্রেরি, এবং ব্যাজ ডিজাইন স্পেসিফিকেশন হোস্ট করা আছে। উল্লিখিত উদাহরণগুলো মধ্যে কোড কভারেজ শতাংশ, স্টেবল রিলিজ ভার্সন, প্যাকেজ ম্যানেজার রিলিজ, ডিপেন্ডেন্সি স্ট্যাটাস, স্ট্যাটিক কোড অ্যানালাইসিস গ্রেড, SemVer ভার্সন, সাপ্তাহিক Liberapay ডোনেশন, Python প্যাকেজ ডাউনলোড, Chrome ওয়েব স্টোর এক্সটেনশন রেটিং ও Uptime Robot আপটাইম শতাংশ অন্তর্ভুক্ত। ব্যবহারকারীরা একটি URL প্যাটার্ন দিয়ে কাস্টম ব্যাজ তৈরি করতে পারে। README-তে একটি কুইকস্টার্ট বর্ণনা করা আছে, যেখানে ব্যবহারকারীরা ব্যাজের সম্পূর্ণ লিস্ট ব্রাউজ করতে পারে, ক্যাটাগরি সার্চ বা ব্রাউজ করতে পারে, একটি ব্যাজ ক্লিক করে ব্যবহারকারীর নাম বা রিপো এর মতো প্রয়োজনীয় ডেটা পূরণ করতে পারে, ঐচ্ছিকভাবে লেবেল ও রঙ কাস্টমাইজ করতে পারে, এরপর GitHub রিডমেস বা অন্যান্য ওয়েব পেজের জন্য ব্যাজের URL বা স্নিপেট কপি করতে পারে। অবদান ইস্যু ও পুল রিকোয়েস্টের মাধ্যমে কমিউনিটি ভিত্তিক; README-তে অবদানকারীদের একটি সেবা যোগ বা পরিবর্তন করার সময় টেস্ট যোগ করার অনুরোধ করা আছে, এবং একটি ব্যাজ যোগ করার টিউটোরিয়ালের লিংক দেওয়া আছে। এটি এছাড়া গুড ফার্স্ট ইস্যু ও সিকিউরিটি পলিসিরও রেফারেন্স দেয়। ডেভেলপমেন্টের জন্য, README-তে Node 24 ইনস্টল করা, রিপোজিটরি ক্লোন করা, npm ci, npm start চালানো, এবং localhost:3000 ওপেন করার তালিকা দেওয়া আছে। সার্ভার সোর্সের পরিবর্তনগুলো nodemon এর মাধ্যমে রিস্টার্ট হয়, যেখানে ফ্রন্টএন্ডের পরিবর্তনগুলো Docusaurus ডেভ সার্ভারের মাধ্যমে রিলোড হয়; ব্যাজ ডেফিনিশনগুলো প্রথম সার্ভার স্টার্টের আগে বিল্ড করা হয় এবং npm run prestart বা একটি রিস্টার্টের মাধ্যমে পুনরায় জেনারেট করা যায়। একটি ব্যাজ কমান্ড লাইন থেকে npm run badge চালিয়ে ডিবাগ করা যায়, সম্পূর্ণ URL সহ। স্ন্যাপশট টেস্টগুলো SVG বা JSON আউটপুটকে রক্ষা করে; ইচ্ছাকৃত আউটপুট পরিবর্তনগুলো SNAPSHOT_DRY=1 npm run test:package চালিয়ে প্রিভিউ করা যায় এবং SNAPSHOT_UPDATE=1 দিয়ে আপডেট করা যায়। সার্ভার ঐচ্ছিকভাবে Sentry ও Prometheus ব্যবহার করতে পারে। সেলফ-হোস্টিং ডকুমেন্টেশনের লিংক দেওয়া আছে। সম্পর্কিত প্রকল্পগুলো মধ্যে awesome-badges, একটি কিউরেটেড কালেকশন অন্তর্ভুক্ত। README-তে প্রকল্পের ইতিহাস দেওয়া আছে: b.adge.me ছিল মূল সাইট, এটি gh-badges এর ২০১৩ সালের কোড ব্যবহার করত; পরে এই প্রকল্পটি shields.io-এর সাথে মার্জ হয়েছিল। মূল ব্যাজ স্পেসিফিকেশন ২০১৩ সালে উন্নত করা হয়েছিল এবং পরে ২০১৪ সালে পুনরায় ডিজাইন করা হয়েছিল; পুরানো ডিজাইনকে প্লাস্টিক স্টাইল এবং নতুন ডিজাইনকে ফ্ল্যাট স্টাইল বলা হয়। মেইনটেইনার ও অ্যালামনির তালিকা দেওয়া আছে, এবং এই প্রকল্পটি MIT ও Apache 2.0-এর অধীনে ডুয়াল লাইসেন্সড। এটি এছাড়া কমিউনিটি ফান্ডিং ও সাপোর্টের লিংকও দেয়।