FastAPI Template

قالب fastapi

وصف

قالب Fastapi هو قالب المشروع الذي يوفر بنية ملفات جيدة وإعداد لإنشاء تطبيقات Fastapi. ويشمل بيئة تطوير تم تكوينها مسبقًا ، ونصوص نشر جاهزة للإنتاج ، وخيارات تكوين SSL. يهدف هذا القالب إلى تسهيل على المطورين بدء مشاريع Fastapi الجديدة مع أساس قوي وأفضل الممارسات في الاعتبار.

سمات

• تنظيف بنية الملفات لتنظيم تطبيق fastapi الخاص بك
• إعداد البيئة الافتراضية لتبعيات معزولة
• نصوص باش جاهزة للإنتاج للنشر
• إعداد SSL القابل للتكوين للاتصالات الآمنة
• قطع التسجيل المسبقة مع سجلات تم حفظها في ملف
• واجهة مستخدم الويب لعرض السجلات والبحث مع العديد من الخيارات

تثبيت

1. استنساخ المستودع:

git clone https://github.com/Neko-Nik/FastAPI-Template.git
cd FastAPI-Template

2. قم بإنشاء بيئة افتراضية وتفعيلها:

python3 -m venv virtualenv
source virtualenv/bin/activate

3. تثبيت التبعيات المطلوبة:

pip3 install -r requirements.txt

الاستخدام

لتشغيل التطبيق محليًا ، باستخدام Uvicorn أو Gunicorn:

باستخدام uvicorn: uvicorn api.main:app --reload --port 8086

باستخدام Gunicorn: gunicorn -k uvicorn.workers.UvicornWorker api.main:app

سيبدأ التطبيق في العمل على http: // localhost: 8086.

النشر

لنشر الإنتاج ، يوفر القالب خط أنابيب Docker CI وملفات تكوين docker-compose لسهولة النشر.

المساهمة

المساهمات مرحب بها! إذا كنت ترغب في المساهمة في قالب Fastapi ، فيرجى اتباع هذه الخطوات:

1. شوكة المستودع
2. قم بإنشاء فرع جديد للميزة أو إصلاح الأخطاء
3. قم بإجراء تغييراتك وارتكابها
4. ادفع التغييرات الخاصة بك على شوكة
5. أرسل طلب سحب إلى الفرع master للمستودع الأصلي

يرجى التأكد من اتباع نمط الكود الحالي وإضافة اختبارات لأي ميزات جديدة أو إصلاحات الأخطاء.

رخصة

يتم إصدار قالب Fastapi تحت رخصة معهد ماساتشوستس للتكنولوجيا. أنت حر في استخدام هذا القالب وتعديله وتوزيعه لأي غرض.