digital form builder

XGov منشئ النماذج الرقمية

المساهمات

القضايا وطلبات السحب هي موضع ترحيب. يرجى التحقق من CONTRIBUTING.md أولاً!

هذا المستودع عبارة عن ريبو أحادي لـ

• @xgovformbuilder/runner - خادم Hapi الذي يمكنه "تشغيل" نموذج من ملف JSON
• @xgovformbuilder/designer - تطبيق React للمساعدة في بناء النماذج
• @xgovformbuilder/model - يخدم نموذج البيانات والمساعدين الآخرين
• @xgovformbuilder/e2e - اختبارات شاملة

يتم تفرع عمليات إعادة الشراء من أداة إنشاء النماذج الرقمية التابعة لـ DEFRA.

هذا (يقترب من) مستودع مساحات عمل غزل 2 بدون تثبيت. .yarnrc.yml يسمح لنا بمحاذاة بيئات الغزل لدينا. يرجى الالتزام بأي مكونات إضافية في .yarn، لكن لا تلتزم بـ .yarn/cache. سوف يقوم CI بحفظ واستعادة ذاكرات التخزين المؤقت.

ستتعامل مساحات العمل مع ربط الحزم، لذلك لا يتعين علينا تشغيل yarn link يدويًا. سيتعامل أيضًا مع رفع وحدات العقدة لأي حزم تتم مشاركتها بين عمليات إعادة الشراء، وبالتالي تقليل أوقات التثبيت. نأمل أن كل شيء يعمل فقط™️.

راجع أيضًا ملفات README الفردية للحصول على معلومات إضافية:

• التمهيدي للعداء
• التمهيدي للمصمم
• التمهيدي النموذجي
• e2e (اختبارات الدخان) التمهيدي

يثبت

قم دائمًا بتشغيل البرامج النصية من الدليل الجذر.

1. تأكد من أنك تستخدم العقدة 20 node --version .
2. تأكد من تثبيت الغزل 1.22+. لا تحتاج إلى تثبيت الغزل 2.4+، سوف يكتشف الغزل الثنائي 2 داخل .yarn وسيتم استخدامه.
3. في حالة استخدام المصمم:
   • لاحظ أن المصمم يتطلب تشغيل العداء باستخدام إعدادات NODE_ENV=development الافتراضية (راجع runner/config/development.json) لتمكين نشر النماذج ومعاينتها أثناء التصميم.
4. قم بتشغيل أمر $ yarn لتثبيت جميع التبعيات في جميع مساحات العمل.
5. قم بتشغيل $ yarn build لإنشاء كافة مساحات العمل (وهذا ضروري لأن التبعيات يمكن أن تعتمد على بعضها البعض).

كما ذكرنا سابقًا، قم دائمًا بتشغيل البرامج النصية من الدليل الجذر. نظرًا لأن مساحات العمل لا تحتوي على نصوص برمجية أو حزم تحتاج إلى تشغيلها من داخل مجلداتها ومن خلال التشغيل في الدليل الجذر، يمكن لـ الغزل 2 حل البرامج النصية/الحزم بشكل صحيح.

لمعرفة المزيد حول مساحات العمل، تحقق من هذه الروابط:

• مساحات العمل في الغزل
• مساحات العمل

أريد أن...

تشغيل برنامج نصي لمساحات عمل محددة

$ yarn [runner|designer|model] name-of-script

على سبيل المثال: yarn designer start أو yarn runner add babel-core --dev

تشغيل برنامج نصي لكل من مساحات العمل

$ yarn workspaces foreach run name-of-script

شاهد وقم ببناء التغييرات في جميع اتفاقيات إعادة الشراء

لا أنصح به إلا إذا كان لديك معالج قوي.

$ yarn watch

إضافة تبعية إلى كافة مساحات العمل

$ yarn add packagename

إنشاء مساحة عمل جديدة

1. قم بإنشاء دليل جديد لمساحة العمل وقم ببدء تشغيله
   1. $ mkdir myNewLib
   2. $ cd myNewlib
   3. $ yarn init
2. في package.json الجذر.json
   1. أضف myNewLib إلى كائن workspaces .

استكشاف الأخطاء وإصلاحها

إذا كان لديك أي مشاكل، أرسل مشكلة أو أرسل رسالة عبر gitter.

خطأ: ENOENT: لا يوجد مثل هذا الملف أو الدليل، scandir 'xxx/node_modules/node-sass/vendor'

/vendor غير موجود لأنه لم يتم بناؤه أو إعادة بنائه. قد تواجه $ yarn rebuild هذه المشكلة مع core-js $ yarn rebuild only node-sass fsevents و nodemailer وما إلى ذلك.

سي.آي

نحن نستخدم إجراءات GitHub لتشغيل عملية CI الخاصة بنا. عرض تصور لسير العمل هنا.

الإصدار

سيتم زيادة أرقام الإصدارات تلقائيًا بناءً على رسائل الالتزام وSemVer (Major.Minor.Patch). عند الدمج، ألحق التزام الدمج الخاص بك بما يلي:

• major: أو breaking: - مثلاً breaking: removing feature X . سيؤدي هذا إلى زيادة الإصدار الرئيسي - على سبيل المثال: 1.1.0 إلى 2.0.0
• minor: أو feature: - على سبيل المثال، feature: new component . سيؤدي هذا إلى زيادة الإصدار MINOR - على سبيل المثال: 1.1.0 إلى 1.2.0
• patch: أو fix: - على سبيل المثال، fix: url bug - سيؤدي هذا إلى زيادة إصدار التصحيح - على سبيل المثال: 1.0.0 إلى 1.0.1 (سيحدث هذا أيضًا بشكل افتراضي)

بيئة التطوير

يتم تشغيل سير عمل التطوير عندما يتم دمج العلاقات العامة في الملف الرئيسي، ويمكنك مراقبته من خلال علامة تبويب الإجراء الخاصة بالمستودع.

يحتوي سير العمل على مهمتين منفصلتين يتم تشغيلهما بالتوازي، واحدة للعداء والأخرى لتطبيق المصمم.

كلا الوظيفتين تعملان على النحو التالي:

1. قم ببناء صورة عامل الإرساء بكل التبعيات.
2. ادفع الصورة إلى سجل حاوية Heroku.
3. الافراج عن أحدث صورة.

سيتم تشغيل أحدث الإصدارات هنا: Runner / Designer.

اختبارات الدخان

يتم إجراء مجموعة من اختبارات الدخان ضد جميع العلاقات العامة. هناك وظيفة Cron تقوم بتنفيذ اختبارات الدخان ضد عمليات نشر Heroku ومن المقرر أن يتم تشغيلها في منتصف الليل كل يوم.

يمكن العثور على مجموعة قديمة من اختبارات الدخان في هذا المستودع. تمت إزالتها حتى يمكن تشغيل المشروع على العقدة 18.

سيتم ترحيل اختبارات الدخان لاستخدام cypress.io في الأشهر المقبلة.