wagtail torchbox

torchbox.com على wagtail - متقاعد

تحذير

هذا الإصدار من torchbox.com repo متقاعد الآن. ربما تريد https://github.com/torchbox/torchbox.com.

يتم الحفاظ على محتوى Reame القديم أدناه للرجوع إليه.

 *
*
*
*
*
*
*
*
*
*

الوثائق التاريخية

هذا هو موقع Torchbox.com الرئيسي. يمكن العثور على قسم الوظائف في هذا الموقع في Torchbox/Careers.

الوثائق الفنية

يحتوي هذا المشروع على وثائق فنية مكتوبة في تخفيض التنفيذ في مجلد /docs . هذا يغطي ، من بين آخرين:

• التكامل المستمر
• النشر
• GIT المتفرعة
• مؤتمرات المشروع

يمكنك عرضه باستخدام mkdocs عن طريق التشغيل:

mkdocs serve

ستكون الوثائق متاحة على: http: // localhost: 8001/

إنشاء بناء محلي

يتضمن هذا المستودع تكوين docker-compose لتشغيل المشروع في حاويات Docker المحلية ، و Fabfile لتوفير هذا وإدارته.

هناك عدد من الأوامر الأخرى للمساعدة في التطوير باستخدام نص النسيج. لرؤيتهم جميعًا ، قم بالتشغيل:

fab -l

التبعيات

ما يلي مطلوب لتشغيل البيئة المحلية. تم تأكيد الحد الأدنى من الإصدارات المحددة على أنها تعمل: إذا كان لديك إصدارات قديمة مثبتة بالفعل ، فقد تعمل ، ولكن ليس مضمونًا للقيام بذلك.

• Docker ، الإصدار 19.0.0 أو فوق
  • سطح المكتب Docker لـ Mac Installer
  • محرك Docker لمثبتات Linux
• Docker Compose ، الإصدار 1.24.0 أو فوق
  • تثبيت التعليمات (Linux-only: تم تثبيت Compose بالفعل لمستخدمي Mac كجزء من Docker Desktop.)
• النسيج ، الإصدار 2.4.0 أو فوق
  • تثبيت التعليمات
• بيثون ، الإصدار 3.6.9 أو فوق

لاحظ أنه على نظام التشغيل Mac OS ، إذا كان لديك نسخة أقدم من Fabric مثبتة ، فقد تحتاج إلى إلغاء تثبيت الإصدار القديم ثم تثبيت الإصدار الجديد باستخدام PIP3:

pip uninstall fabric
pip3 install fabric

يمكنك إدارة إصدارات Python المختلفة عن طريق إعداد pyenv : https://realpython.com/intro-to-pyenv/

بالإضافة إلى ذلك ، للتفاعل مع بيئات الإنتاج / التدريج ، ستحتاج:

• هيروكو كلي
• AWS CLI

تشغيل البناء المحلي لأول مرة

إذا كنت تستخدم سطح Docker Desktop ، فتأكد من الموارد: تسمح إعدادات مشاركة الملفات بتركيب الدليل المستنسخ في حاوية الويب (تجنب mounting فشل وقت تشغيل OCI في نهاية خطوة الإنشاء).

يمكن إجراء بناء محلي عن طريق التشغيل:

git clone [email protected]:torchbox/wagtail-torchbox.git
cd wagtail-torchbox
fab build
fab migrate
fab start

سيبدأ هذا الحاويات في الخلفية ، ولكن ليس Django. للقيام بذلك ، قم بالتواصل مع حاوية الويب باستخدام fab sh و honcho start تشغيل كل من Django و WebPack Dev Server في المقدمة.

ثم ، قم بالتواصل مع الحاوية الجارية مرة أخرى ( fab sh ) و:

dj createcachetable
dj createsuperuser

يجب أن يكون الموقع متاحًا على جهاز المضيف على: http://127.0.0.1:8000/

إذا كنت ترغب فقط في تشغيل الواجهة الأمامية أو الأدوات الخلفية ، فإن أوامر تشغيل honcho في docker/Procfile .

عند بدء تشغيل الحاوية أولاً ، قد لا تكون الملفات الثابتة موجودة ، أو قد تكون قديمة. لحل هذا ، ما عليك سوى تشغيل npm run build .

أدوات الواجهة الأمامية

فيما يلي الأوامر المشتركة:

 # Install front-end dependencies.
npm install
# Start the Webpack build in watch mode, without live-reload.
npm run start
# Start the Webpack server build on port 3000 only with live-reload.
npm run build
# Do a one-off Webpack production build.
npm run build:prod

هناك طريقتان لتشغيل أدوات الواجهة الأمامية:

• في دوكر. هذا هو الافتراضي والأكثر احتمالًا وأمانًا ، ولكنه أبطأ بكثير على MacOS.
• أو قم بتشغيل أوامر NPM من محطة على جهازك المحلي. قم بإنشاء ملف .env في جذر المشروع (انظر .env.example ) مع FRONTEND=local . لن تبدأ fab start حاوية frontend . الآن ، عند تشغيل fab start ، لن يحاول Docker ربط المنافذ المطلوبة لخادم Dev Frontend ، مما يعني أنه يمكن تشغيله محليًا. لا تزال جميع الأدوات متوفرة في الحاوية.

تثبيت حزم بيثون

يمكن تثبيت حزم Python باستخدام poetry في حاوية الويب:

 fab sh
poetry add wagtail-guide

لإعادة تعيين التبعيات المثبتة مرة أخرى إلى كيفية وجودها في ملف poetry.lock :

 fab sh
poetry install --no-root

عمليات النشر

للنشر ، قم بدمج فرع الميزات الخاص بك master أو فرع staging . بمجرد مرور خطوط أنابيب CI ، سيتم نشرها في موقع Heroku المعني تلقائيًا.

يتم ذلك عبر تكامل Heroku Github.