quicky

Quicky CLI

أداة CLI التي تبسيط نشر وإدارة مشاريع Next.js و Node.js التي تستضيفها ، وتمكين التهيئة ، والنشر من GitHub ، وتحديث ، وحذف ، وإدارة التطبيقات ، إلى جانب الإعداد دون عناء من المجالات وشهادات SSL ، مما يبسيط الحياة على الويب بالكامل على الخوادم المتطابقة.

سمات

• ؟ GitHub Integration : تهيئة مشاريع Next.js و Node.js من Next.js و Node.js من مستودعات GitHub الخاصة والعامة.
• إدارة العملية : رافعة PM2 لدورة حياة التطبيق والمراقبة.
• صيانة المشروع : بسهولة تحديث أو إزالة المشاريع المنشورة.
• Automation Domain & SSL : تلقائيًا تكوين NGINX للشهادات المخصصة وشهادات SSL ، مما يتيح لك إضافة/إزالة المجالات من مشاريعك.
• نظرة عامة على التكوين : قائمة وفحص التفاصيل لجميع المشاريع المنشورة ومجالاتها.
• ؟ WebHook Management : قم بإعداد وإدارة وتحديث Webhooks للنشر الآلي.
• الوصول إلى لوحة القيادة : إدارة ومراقبة خادم WebHook الخاص بك من خلال لوحة معلومات مستندة إلى الويب.
• ؟ إدارة السجل : عرض سجلات الإخراج والخطأ لخادم WebHook الخاص بك.

المتطلبات الأساسية

لتثبيت Quicky ، احصل أولاً على خادم Linux Ubuntu من مزود مثل Digitalocean أو Hetzner.

بعد إعداد الخادم الخاص بك ، قم بتوصيله (على سبيل المثال ، عبر SSH) وقم بتثبيت Node.js و NPM عن طريق تنفيذ الأوامر التالية:

sudo apt update
sudo apt install -y nodejs npm

تثبيت

تثبيت Quicky على مستوى العالم باستخدام npx أو npm :

npx quicky@latest install

أو

sudo npm install -g quicky

ملاحظة : يعد أمر sudo ضروريًا للتثبيت العالمي ولمنع مشكلات الإذن عند تكوين المجالات.

الاستخدام

1. تهيئة Quicky

quicky init

سيطالبك هذا الأمر بإدخال بيانات اعتماد GitHub والتكوينات الأساسية لإعداد مشاريعك.

يتطلب Quicky الرمز المميز للوصول إلى GitHub واسم المستخدم للتفاعل مع مستودعاتك. لإنشاء رمز جديد ، اتبع هذه الخطوات:

1. تفضل بزيارة صفحة رموز الوصول الشخصية لـ GitHub وتأكد من استخدام الرموز (الكلاسيكية) .
2. انقر فوق إنشاء رمز جديد .
3. حدد النطاقات المطلوبة للوصول إلى المستودع.
4. انقر فوق إنشاء الرمز المميز .
5. انسخ الرمز المميز وقم بتوفيره إلى Quicky مثل الرمز المميز للوصول إلى GitHub. سيتم تخزين هذا الرمز المميز محليًا للاستخدام في المستقبل.

لتمكين النشر المستمر ، يطلب Quicky عنوان URL WebHook للنشر الآلي. يستخدم رمز GitHub الخاص بك لإعداد مستمع Webhook وإنشاء Webhooks بشكل ديناميكي. ستحتاج إلى إنشاء نطاق فرعي (على سبيل المثال ، webhook.example.com ) يشير إلى عنوان IP الخاص بالخادم. يمكن القيام بذلك عن طريق إضافة سجل A مع عنوان IPv4 للخادم الخاص بك.

2. نشر مشروع

quicky deploy

يدعم Quicky الآن نشر كل من مشاريع Next.js و Node.js. أثناء عملية النشر ، سيُطلب منك تحديد نوع المشروع:

• Next.js
• node.js

نشر مشروع NEXT.JS

اتبع المطالبات لتحديد مستودع next.js الخاص بك. سوف يتعامل Quicky مع النشر والتكوين تلقائيًا.

نشر مشروع Node.js

قبل نشر مشروع Node.js ، تأكد من تسمية ملف التطبيق الرئيسي الخاص بك index.js . لديك خيار لتحديد ما إذا كان مشروعك سيستخدم منفذًا:

• مع المنفذ : توفير رقم المنفذ (على سبيل المثال ، 3000). سيقوم Quicky بحفظه في ملف .env ، مما يتيح لك توجيه المجالات إلى مشروعك.
• بدون منفذ : بدون تحديد منفذ ، لا يمكن توجيه المجالات إلى المشروع ، مما تسبب في عمله فقط كخدمة أساسية.

سيطالبك هذا الأمر بتوفير:

• اسم المستخدم الخاص بك github أو أي اسم مؤسسة
• اسم المستودع
• نوع المشروع ( next.js أو node.js )
• إذا تم تحديد Node.js :
  • ما إذا كان مشروعك يستخدم منفذًا
    • إذا كانت الإجابة بنعم ، فإن رقم المنفذ الذي يجب أن يعمل عليه المشروع (على سبيل المثال ، 3000)

متغيرات البيئة - أثناء النشر ، ستُسأل عما إذا كنت ترغب في إضافة متغيرات البيئة إلى مشروعك. سوف تعالج Quicky حفظ رقم المنفذ في ملف .env لمشروعك إن أمكن.

3. إدارة المشاريع

quicky manage

يسرد جميع المشاريع المنشورة ويسمح لك بالبدء أو إيقاف أو إعادة تشغيل أو تحديث أو حذف مشروع معين.

4. قم بتحديث المشروع بواسطة PID

quicky update < pid >

يقوم بتحديث مشروع معين من قبل PID مع أحدث التغييرات من مستودع GitHub.

5. نظرة عامة على التكوين

quicky list

يعرض نظرة عامة على جميع المشاريع المنشورة ، بما في ذلك التفاصيل التالية:

• PID : معرف المشروع.
• المالك : اسم المستخدم GitHub أو اسم المنظمة.
• مستودع : اسم مستودع جيثب.
• المنفذ : رقم المنفذ الذي يعمل عليه المشروع.
• حالة PM2 : الحالة الحالية لعملية PM2.
• آخر تحديث : تاريخ ووقت آخر نشر/تحديث.

6. المجالات

قبل إضافة مجال إلى مشروعك ، تحتاج إلى:

1. ؟ شراء اسم مجال من مسجل مثل NameCheap أو Godaddy.
2. قم بإنشاء سجل A يشير إلى عنوان IPv4 الخاص بالخادم.

بمجرد حصولك على مجالك ، يمكنك بسهولة إدارته مع الأمر التالي:

quicky domains

يتيح لك هذا الأمر إضافة وإزالة المجالات والنطاقات الفرعية لمشاريعك دون عناء.

7

يوفر Quicky خادم WebHook مدمج لتحديث مشاريعك تلقائيًا عند الضغط على GitHub. إليك كيفية إعداده:

إعداد خادم webhook

1. المتطلبات الأساسية

   • تأكد من أن لديك نطاقًا فرعيًا (على سبيل المثال ، webhook.example.com) يشير إلى عنوان IP الخاص بالخادم الخاص بك
   • أضف سجل DNS مع عنوان IPv4 الخاص بالخادم الخاص بك

2. الإعداد الأولي

   quicky webhooks

   هذا الأمر سوف:

   • تحقق مما إذا كان خادم WebHook يعمل
   • يرشدك من خلال عملية الإعداد إذا لزم الأمر
   • موجه لتكوين webhook

3. إعدادات

   • ستحتاج إلى توفير عنوان URL Webhook (التنسيق: https: /// webhook)
   • سيبدأ خادم WebHook تلقائيًا بعد الإعداد

4. تحقق من الإعداد

   quicky webhooks status

   هذا يظهر:

   • حالة تشغيل الخادم
   • خيارات لإعادة تشغيل/إيقاف الخادم
   • الوصول إلى سجلات الخادم

Webhook Dashboard

1. إعداد لوحة القيادة

   quicky webhooks dashboard

   • إعداد اسم المستخدم وكلمة المرور
   • تم تخزين بيانات الاعتماد بشكل آمن

2. الوصول إلى لوحة القيادة

   • افتح متصفحك على https: /// dashboard
   • قم بتسجيل الدخول باستخدام بيانات الاعتماد الخاصة بك
   • مراقبة حالة webhook
   • عرض سجلات webhook

إدارة Webhooks

استخدم quicky webhooks مع هذه الأوامر:

• status - تحقق من حالة خادم WebHook
• restart - أعد تشغيل خادم WebHook
• stop - أوقف خادم WebHook
• logs - عرض سجلات خادم WebHook
• dashboard - الوصول إلى لوحة معلومات WebHook

8. ترقية Quicky

quicky upgrade

ترقيات Quicky إلى أحدث إصدار.

9. إلغاء تثبيت Quicky

quicky uninstall

يزيل Quicky من نظامك.

رخصة

تم ترخيص هذا المشروع بموجب ترخيص معهد ماساتشوستس للتكنولوجيا - راجع ملف LICENSE للحصول على التفاصيل.

مؤلف

• alohe

لا تتردد في التواصل معي؟ alemalohe إذا كان لديك أي أسئلة أو ملاحظات!

المساهمة

المساهمات مرحب بها! يرجى قراءة الملف المساهم للحصول على إرشادات حول كيفية البدء.