تنزيل BEEQ - تنزيل رمز المصدر BEEQ

BEEQ

مكونات الطرف الثالث

v1.8.1

تنزيل

Beeq ، مبادرة مكتبة مكونات الويب

يحتوي هذا المستودع على الكود المصدري لمكونات الويب الموجودة في نظام تصميم BEEQ.

طَرد	إصدار	الوثائق
`@beeq/core`		ReadMe
`@beeq/angular`		ReadMe
`@beeq/react`		ReadMe
`@beeq/vue`		ReadMe
`@beeq/tailwindcss`		ReadMe

️ قبل البدء ️

بناء ؟

تم تنظيم المشروع باعتباره monorepo NX:

 ├── ? packages
  ├── ? beeq
  ├── ? beeq-angular
  ├── ? beeq-react
  ├── ? beeq-vue
  ├── ...
  ├── ? beeq-tailwindcss
  ├── ...
├── ? tools
├── package.json
├── package-lock.json

أين:

الحزم/BEEQ: المكتبة الأساسية (مصدر لجميع العناصر/المكونات المنفذة)
الحزم/BEEQ-Angular: غلاف خاص بالزاويين لمكتبة Beeq Core
حزم/BEEQ-React: React.js محددة الغلاف لمكتبة Beeq Core
حزم/BEEQ-VUE: غلاف خاص vue.js لمكتبة Beeq Core
الحزم/BEEQ-TAILWINDCSS: تكوين Tailwindcss من BEEQ

التبعيات؟

نوصي باستخدام Volta لإدارة إصدارات العقدة و NPM. عملية التثبيت واضحة إلى حد ما ، وكما هو مشار إليه على موقعهم الرسمي:

مع Volta ، يمكنك تحديد محرك العقدة مرة واحدة ثم التوقف عن القلق بشأنه. يمكنك التبديل بين المشاريع والتوقف عن الاضطرار إلى التبديل يدويًا بين العقد.

بمجرد تثبيت Volta ، كلما قمت بتغيير إلى مجلد BEEQ محليًا ، سيتم تحويلها إلى إصدارات العقدة اليمنى و NPM في package.json :

  "volta" : {
    "node" : " 20.11.1 " ,
    "npm" : " 10.4.0 "
  }

Volta ليس إلزاميًا ، فلا يزال بإمكانك استخدام أي إعداد عقدة/NPM يناسبك أكثر ، فقط ضع في اعتبارك أنك ستحتاج:

NodeJS v18.x أو أعلى
NPM V8 أو أعلى

الاستخدام

يتم نشر مكونات BEEQ إلى سجل MANGER NPM. يمكنك استخدام @beeq/core أو أي من الأغطية الخاصة بالإطار ( @beeq/angular ، @beeq/react ) اعتمادًا على مجموعة التكنولوجيا في مشروعك. تأكد من اتباع تعليمات الاستخدام لكل حزمة:

كيفية استخدام حزمة @beeq/core
؟ كيفية استخدام الحزمة @beeq/angular
كيفية استخدام حزمة @beeq/react
؟ كيفية استخدام حزمة @beeq/vue
؟ كيفية استخدام @beeq/tailwindcss الإعداد المسبق

لا تتردد في التحقق من قصصنا لمشاهدة جميع مكونات BEEQ التي تم إصدارها. هناك يمكنك العثور على جميع واجهات برمجة تطبيقات المكون (الخصائص والأحداث والأساليب المكشوفة) إلى جانب الاختلافات التي يسمح بها كل مكون.

تشغيل المشروع؟ ‍

لتطوير/تمديد المكونات على نظام تصميم BEEQ ، يرجى تورك هذا الريبو في Github واستنساخه محليًا إلى دليل جديد:

git clone https://github.com/ < YOUR_GITHUB_USERNAME > /BEEQ.git BEEQ-Design-System
cd BEEQ-Design-System
git checkout main

تثبيت

ببساطة الجري:

npm ci
# Make sure to build first the project before starting it
npm run build
npm start

ابدأ الترميز؟!

يبني ؟

لبناء الإنتاج ، فقط تشغيل:

npm run build

امتحان ؟

يستخدم Beeq Jest لاختبارات الوحدة والزحف والعرائس للاختبارات الشاملة.

يمكنك إجراء جميع الاختبارات مرة واحدة ، من خلال التنفيذ:

npm run test

إذا حصلت على خطأ مشابه للخطأ أدناه ، فحاول التحقق من الفرع main محليًا وقم بإجراء الاختبارات مرة أخرى .

fatal: Not a valid object name main
fatal: No such ref: ' main '
nx affected

توليد مكون

يأتي Beeq مع مولد مكون يوفر لك الوقت عند إنشاء الهيكل العظمي لمكون جديد. لاستخدام المولد ، تحتاج فقط إلى تشغيل الأمر التالي واتباع الإرشادات الموجودة في مطالبة CLI:

npm run g

المساهمة

؟ إذا كنت في حالة مزاجية وتريد المساعدة؟ ، يرجى قراءة بعناية الإرشادات المساهمة ومعايير التطوير.

❗ عند العمل على إصلاح الأخطاء ، ميزة جديدة ، وما إلى ذلك ، يرجى ملاحظة أننا نتبع سير عمل gitflow. تأكد من اتباع الإرشادات من إرشادات استراتيجية التفرع المساهمة حول كيفية إنشاء فرعك عند البدء في العمل على الخلل/التثبيت الساخن ، ميزة جديدة ، إلخ.