इस प्रोजेक्ट के बारे में

Saas UI एक ओपन-सोर्स डिज़ाइन सिस्टम और सोर्स कंपोनेंट रजिस्ट्री है, जिसका उद्देश्य B2B एप्लिकेशन और डैशबोर्ड बनाने वाली टीमें हैं। यह Chakra UI पर आधारित है: Chakra प्रिमिटिव्स @chakra-ui/react से आते हैं, जबकि Saas UI टोकन और रेसिपीज़ @saas-ui/chakra-preset से आते हैं। Sidebar जैसे एडिटेबल कंपोजिशन को @saas-ui/cli के माध्यम से एप्लिकेशन में इंस्टॉल किया जाता है। रिपॉजिटरी में प्रीसेट, रजिस्ट्री कंपाइलर और टेम्पलेट्स, CLI, सपोर्टिंग पैकेज, उदाहरण और डॉक्यूमेंटेशन वेबसाइट शामिल हैं। ओपन-सोर्स वितरण में Chakra टोकन, रेसिपीज़, सिमेंटिक स्टाइलिंग और सिस्टम कॉन्फ़िगरेशन; एडिटेबल रजिस्ट्री कंपोनेंट्स और एप्लिकेशन कंपोजिशन; CLI इनिशियलाइज़ेशन, इंस्टॉलेशन, माइग्रेशन, डिफ और अपडेट वर्कफ़्लो; और सपोर्टिंग हुक्स, फॉर्म्स, ऑथेंटिकेशन और मोडल पैकेज शामिल हैं। एक अलग Pro ऑफरिंग एडिटेबल एप्लिकेशन ब्लॉक्स का एक प्रीमियम कैटलॉग प्रदान करती है जिसे ऑथेंटिकेटेड रजिस्ट्री के माध्यम से इंस्टॉल किया जाता है; README में उदाहरण Pro क्षेत्रों जैसे कि एक उदाहरण Next.js SaaS ऐप, ऑथेंटिकेशन स्क्रीन, ऐप लेआउट, DataGrid/DataBoard, अकाउंट और सेटिंग्स पेज, फीचर फ्लैग्स, बिलिंग/सब्सक्रिप्शन मैनेजमेंट, React Query के साथ मॉक किया गया API, कलर स्कीम्स, थीम्स, ऑनबोर्डिंग फ्लो और उदाहरण पेज का उल्लेख है। शुरुआत करने के लिए किसी मौजूदा React प्रोजेक्ट को इनिशियलाइज़ करने हेतु npx @saas-ui/cli@rc init का उपयोग किया जाता है, जिसके बाद एडिटेबल कंपोनेंट्स या कंपोजिशन जोड़ने के लिए npx @saas-ui/cli@rc add sidebar का उपयोग किया जाता है। इनिशियलाइज़ेशन संगत Chakra, Emotion और प्रीसेट डिपेंडेंसीज़ को इंस्टॉल करता है, components.json बनाता है और लोकल प्रोवाइडर सेटअप इंस्टॉल करता है। मौजूदा @saas-ui/react उपयोगकर्ताओं को माइग्रेशन गाइड की ओर निर्देशित किया जाता है; ट्रांज़िशन के दौरान पैकेज उपलब्ध रहता है, और README यह दावा नहीं करता है कि npm डेप्रिकेशन या रिमूवल पहले ही हो चुका है। यह रिपॉजिटरी pnpm 10 या उससे नए संस्करण का उपयोग करने वाला एक pnpm वर्कस्पेस है, जिसमें Storybook, पैकेज बिल्ड्स और डॉक्यूमेंटेशन वेबसाइट के लिए स्क्रिप्ट्स हैं। डॉक्स वेबसाइट प्राइवेट पैकेज पर निर्भर करती है और प्राइवेट Git सबमॉड्यूल तक पहुंच के बिना पूरी तरह से बिल्ड नहीं होगी। Saas UI ब्रांडिंग एसेट्स को छोड़कर सभी कोड MIT के तहत लाइसेंस प्राप्त हैं।