الصفحة الرئيسية>المتعلقة بالبرمجة>بايثون
تنزيل
full stack fastapi template

قالب FastAPI المكدس الكامل

مكدس التكنولوجيا والميزات

  • ⚡ FastAPI لواجهة برمجة التطبيقات الخلفية لـ Python.
    • ؟ SQLModel لتفاعلات قاعدة بيانات Python SQL (ORM).
    • ؟ Pydantic، الذي يستخدمه FastAPI، للتحقق من صحة البيانات وإدارة الإعدادات.
    • ؟ PostgreSQL كقاعدة بيانات SQL.
  • رد فعل للواجهة الأمامية.
    • ؟ استخدام TypeScript، والخطافات، وVite، وأجزاء أخرى من مكدس الواجهة الأمامية الحديثة.
    • ؟ واجهة المستخدم Chakra لمكونات الواجهة الأمامية.
    • ؟ عميل الواجهة الأمامية الذي تم إنشاؤه تلقائيًا.
    • ؟ الكاتب المسرحي للاختبار الشامل.
    • ؟ دعم الوضع المظلم.
  • ؟ Docker Compose للتطوير والإنتاج.
  • تأمين تجزئة كلمة المرور بشكل افتراضي.
  • ؟ مصادقة JWT (JSON Web Token).
  • ؟ استعادة كلمة المرور على أساس البريد الإلكتروني.
  • ✅ الاختبارات مع Pytest.
  • ؟ Traefik بمثابة وكيل عكسي / موازن التحميل.
  • ؟ تعليمات النشر باستخدام Docker Compose، بما في ذلك كيفية إعداد وكيل Traefik للواجهة الأمامية للتعامل مع شهادات HTTPS التلقائية.
  • ؟ CI (التكامل المستمر) وCD (النشر المستمر) استنادًا إلى إجراءات GitHub.

تسجيل الدخول إلى لوحة التحكم

مستندات API

لوحة التحكم - المشرف

مستندات API

لوحة المعلومات - إنشاء مستخدم

مستندات API

لوحة القيادة - العناصر

مستندات API

لوحة المعلومات - إعدادات المستخدم

مستندات API

لوحة القيادة - الوضع المظلم

مستندات API

وثائق واجهة برمجة التطبيقات التفاعلية

مستندات API

كيفية استخدامه

يمكنك فقط تفرع هذا المستودع أو استنساخه واستخدامه كما هو.

إنه يعمل فقط.

كيفية استخدام مستودع خاص

إذا كنت تريد أن يكون لديك مستودع خاص، فلن يسمح لك GitHub بتقسيمه ببساطة لأنه لا يسمح بتغيير رؤية الانقسامات.

ولكن يمكنك القيام بما يلي:

  • قم بإنشاء مستودع GitHub جديد، على سبيل المثال my-full-stack .
  • انسخ هذا المستودع يدويًا، واضبط الاسم باسم المشروع الذي تريد استخدامه، على سبيل المثال my-full-stack : 
git clone [email protected]:fastapi/full-stack-fastapi-template.git my-full-stack
  • أدخل في الدليل الجديد: 
 cd my-full-stack
  • قم بتعيين الأصل الجديد إلى مستودعك الجديد، وانسخه من واجهة GitHub، على سبيل المثال: 
git remote set-url origin [email protected]:octocat/my-full-stack.git
  • أضف هذا الريبو باعتباره "جهاز تحكم عن بعد" آخر للسماح لك بالحصول على التحديثات لاحقًا: 
git remote add upstream [email protected]:fastapi/full-stack-fastapi-template.git
  • ادفع الكود إلى مستودعك الجديد: 
git push -u origin master

التحديث من القالب الأصلي

بعد استنساخ المستودع، وبعد إجراء التغييرات، قد ترغب في الحصول على أحدث التغييرات من هذا القالب الأصلي.

  • تأكد من إضافة المستودع الأصلي كجهاز تحكم عن بعد، ويمكنك التحقق منه باستخدام: 
git remote -v

origin    [email protected]:octocat/my-full-stack.git (fetch)
origin    [email protected]:octocat/my-full-stack.git (push)
upstream    [email protected]:fastapi/full-stack-fastapi-template.git (fetch)
upstream    [email protected]:fastapi/full-stack-fastapi-template.git (push)
  • سحب أحدث التغييرات دون دمج: 
git pull --no-commit upstream master

سيؤدي هذا إلى تنزيل أحدث التغييرات من هذا القالب دون الالتزام بها، وبهذه الطريقة يمكنك التحقق من أن كل شيء على ما يرام قبل الالتزام.

  • إذا كانت هناك تعارضات، قم بحلها في المحرر الخاص بك.

  • بمجرد الانتهاء من ذلك، قم بتنفيذ التغييرات: 

git merge --continue

تكوين

يمكنك بعد ذلك تحديث التكوينات في ملفات .env لتخصيص التكوينات الخاصة بك.

قبل نشره، تأكد من تغيير قيم ما يلي على الأقل:

  • SECRET_KEY
  • FIRST_SUPERUSER_PASSWORD
  • POSTGRES_PASSWORD

يمكنك (ويجب عليك) تمريرها كمتغيرات بيئة من الأسرار.

اقرأ مستندات Deployment.md لمزيد من التفاصيل.

إنشاء مفاتيح سرية

تحتوي بعض متغيرات البيئة في الملف .env على قيمة افتراضية وهي changethis .

يجب عليك تغييرها باستخدام مفتاح سري، لإنشاء مفاتيح سرية يمكنك تشغيل الأمر التالي: 

python -c " import secrets; print(secrets.token_urlsafe(32)) "

انسخ المحتوى واستخدمه ككلمة مرور / مفتاح سري. وقم بتشغيل ذلك مرة أخرى لإنشاء مفتاح آمن آخر.

كيفية استخدامه - البديل مع الناسخة

يدعم هذا المستودع أيضًا إنشاء مشروع جديد باستخدام Copier.

سيقوم بنسخ جميع الملفات، ويطرح عليك أسئلة التكوين، ويحدث ملفات .env بإجاباتك.

تثبيت ناسخة

يمكنك تثبيت ناسخة مع: 

pip install copier

أو الأفضل، إذا كان لديك pipx ، فيمكنك تشغيله باستخدام: 

pipx install copier

ملاحظة : إذا كان لديك pipx ، فإن تثبيت آلة التصوير أمر اختياري، ويمكنك تشغيلها مباشرة.

إنشاء مشروع مع ناسخة

حدد اسمًا لدليل مشروعك الجديد، وستستخدمه أدناه. على سبيل المثال، my-awesome-project .

انتقل إلى الدليل الذي سيكون الأصل لمشروعك، وقم بتشغيل الأمر باسم مشروعك: 

copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust

إذا كان لديك pipx ولم تقم بتثبيت copier ، فيمكنك تشغيله مباشرة: 

pipx run copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust

لاحظ أن خيار --trust ضروري لتتمكن من تنفيذ برنامج نصي لما بعد الإنشاء يقوم بتحديث ملفات .env الخاصة بك.

متغيرات الإدخال

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

ولكن لا تقلق، يمكنك فقط تحديث أي من ذلك في ملفات .env بعد ذلك.

متغيرات الإدخال بقيمها الافتراضية (بعضها يتم إنشاؤه تلقائيًا) هي:

  • project_name : (الافتراضي: "FastAPI Project" ) اسم المشروع، المعروض لمستخدمي واجهة برمجة التطبيقات (بتنسيق .env).
  • stack_name : (افتراضي: "fastapi-project" ) اسم المكدس المستخدم لتسميات Docker Compose واسم المشروع (بدون مسافات أو نقاط) (بتنسيق .env).
  • secret_key : (افتراضي: "changethis" ) المفتاح السري للمشروع، المستخدم للأمان، المخزن في .env، يمكنك إنشاء واحد بالطريقة المذكورة أعلاه.
  • first_superuser : (الافتراضي: "[email protected]" ) البريد الإلكتروني للمستخدم المتميز الأول (بتنسيق .env).
  • first_superuser_password : (الافتراضي: "changethis" ) كلمة مرور المستخدم المتميز الأول (بتنسيق .env).
  • smtp_host : (الافتراضي: "") مضيف خادم SMTP لإرسال رسائل البريد الإلكتروني، يمكنك تعيينه لاحقًا في .env.
  • smtp_user : (الافتراضي: "") مستخدم خادم SMTP لإرسال رسائل البريد الإلكتروني، يمكنك تعيينه لاحقًا في .env.
  • smtp_password : (الافتراضي: "") كلمة مرور خادم SMTP لإرسال رسائل البريد الإلكتروني، يمكنك تعيينها لاحقًا في .env.
  • emails_from_email : (الافتراضي: "[email protected]" ) حساب البريد الإلكتروني الذي تريد إرسال رسائل البريد الإلكتروني منه، يمكنك تعيينه لاحقًا في .env.
  • postgres_password : (افتراضي: "changethis" ) كلمة المرور لقاعدة بيانات PostgreSQL، المخزنة في .env، يمكنك إنشاء واحدة باستخدام الطريقة المذكورة أعلاه.
  • sentry_dsn : (الافتراضي: "") DSN لـ Sentry، إذا كنت تستخدمه، فيمكنك تعيينه لاحقًا في .env.

تطوير الواجهة الخلفية

مستندات الواجهة الخلفية: backend/README.md.

تطوير الواجهة الأمامية

مستندات الواجهة الأمامية: frontend/README.md.

النشر

مستندات النشر: Deployment.md.

تطوير

مستندات التطوير العامة: Development.md.

يتضمن ذلك استخدام Docker Compose، والمجالات المحلية المخصصة، وتكوينات .env ، وما إلى ذلك.

ملاحظات الإصدار

تحقق من الملف Release-notes.md.

رخصة

تم ترخيص قالب Full Stack FastAPI بموجب شروط ترخيص MIT.

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل