نظرة عامة
يوفر SDK الفوترة:- مكونات React: مكونات فوترة مسبقة البناء وقابلة للتخصيص لتطبيقات React
- أدوات CLI: واجهة سطر الأوامر لتهيئة المشروع وإدارة المكونات
- دعم الأطر: التكامل مع Next.js، Express.js، Hono، Fastify، وReact
- موفر الدفع: تكامل كامل مع مدفوعات دودي
بدء سريع
ابدأ مع SDK الفوترة في دقائق:1
تثبيت CLI
استخدم npx لتشغيل CLI بدون تثبيت:أو قم بتثبيته عالميًا للاستخدام المتكرر:
2
تهيئة مشروع
قم بتشغيل الإعداد التفاعلي لإنشاء مشروع فوترة جديد:سيتم مطالبتك باختيار:
- إطار العمل المفضل لديك (Next.js، Express.js، Hono، Fastify، React)
- موفر الدفع الخاص بك (مدفوعات دودي)
3
إضافة مكونات
أضف مكونات فوترة فردية إلى مشروعك:
الأطر المدعومة
يدعم SDK الفوترة عدة أطر مع تكامل شامل مع مدفوعات دودي:| الإطار | مدفوعات دودي |
|---|---|
| Next.js | ✅ نعم |
| Express.js | ✅ نعم |
| Hono | ✅ نعم |
| React | ✅ نعم |
| Fastify | ✅ نعم |
أوامر CLI
@billingsdk/cli init
تهيئة مشروع فوترة جديد مع إعداد كامل بما في ذلك تكوين الإطار، تكامل مدفوعات دودي، والاعتماديات الأساسية.
ما الذي يفعله:
- اختيار الإطار: اختر إطار العمل المفضل لديك
- تثبيت القالب: يقوم بتنزيل وتثبيت قوالب محددة للإطار مع تكامل مدفوعات دودي
- إدارة الاعتماديات: يقوم تلقائيًا بتثبيت الاعتماديات المطلوبة
- إنشاء الملفات: ينشئ ملفات التكوين الضرورية وكود البداية
@billingsdk/cli add
أضف مكونات فوترة فردية إلى مشروعك الحالي باستخدام نظام تسجيل shadcn/ui.
أمثلة:
- يقوم بتنزيل تكوين المكون من السجل
- يقوم بتثبيت ملفات المكون في دليل
components/billingsdk/الخاص بك - يقوم بتحديث تكوين مشروعك إذا لزم الأمر
- يقوم بتثبيت أي اعتماديات إضافية
هيكل الملفات الناتجة
بعد تشغيلinit، ستحصل على هيكل مشروع كامل مع:
- مسارات API: نقاط نهاية شاملة للدفع، العملاء، المنتجات، الاشتراكات، وwebhooks
- خطافات: خطافات React لعمليات الفوترة (إذا كنت تستخدم React/Next.js)
- ملفات المكتبة: تهيئة عميل موفر الدفع والأدوات المساعدة
- تكوين البيئة: ملفات متغيرة البيئة كمثال
هيكل مثال Next.js
تكوين البيئة
قم بتكوين متغيرات البيئة الخاصة بك بعد التهيئة:المكونات المتاحة
يوفر SDK الفوترة مجموعة شاملة من مكونات React:- جداول الأسعار: عدة متغيرات لعرض أسعار المنتجات
- إدارة الاشتراكات: مكونات لإدارة اشتراكات العملاء
- مراقبة الاستخدام: مكونات بصرية لتتبع الفوترة المعتمدة على الاستخدام
- مكونات الدفع: تدفقات دفع مسبقة البناء
- بوابة العملاء: مكونات لخدمة العملاء الذاتية
مفتوح المصدر
تم بناء SDK الفوترة على مبادئ مفتوحة المصدر:- 🔍 الشفافية: رؤية كاملة لكيفية عمل المكونات
- 🤝 المجتمع: مبني من قبل المطورين، للمطورين
- 🔒 الأمان: الكود المفتوح يعني أمانًا أفضل من خلال مراجعة الأقران
- 📈 الابتكار: تكرار أسرع من خلال مساهمات المجتمع
تم إصدار SDK الفوترة بموجب رخصة جنو العامة (GPL)، مما يضمن بقاء المشروع مفتوحًا ومجانيًا.
الحصول على المساعدة
تحتاج إلى مساعدة بشأن SDK الفوترة؟- مشاكل GitHub: افتح مشكلة
- التوثيق: زيارة billingsdk.com/docs
- التوثيق الكامل لـ LLMs: billingsdk.com/llms-full.txt
المساهمة
نرحب بالمساهمات! راجع دليل المساهمة للحصول على تفاصيل حول:- الإبلاغ عن الأخطاء
- طلب الميزات
- تقديم طلبات السحب
- إضافة مكونات جديدة
- تحسين التوثيق