readme generator

مشروع مولد README

نظرة عامة على المشروع

مرحبًا بك في مشروع README Generator! تم تصميم هذه الأداة المبتكرة لتبسيط عملية إنشاء ملفات README لمشاريع البرامج. من خلال الاستفادة من قوة الذكاء الاصطناعي التوليدي، فإنه يسمح للمستخدمين بإدخال وصف موجز لمشروعهم، بما في ذلك الغرض منه وميزاته وتفاصيله الفنية، وإنشاء ملف README.md جيد التنظيم وغني بالمعلومات باتباع أفضل الممارسات.

؟ سمات

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

التفاصيل الفنية

تم إنشاء مشروع README Generator بمزيج من Flask للواجهة الخلفية وExpress.js للواجهة الأمامية. ويستخدم نموذج Google Geneative AI لإنشاء محتوى README، مما يضمن مخرجات عالية الجودة وذات صلة.

الواجهة الخلفية ( app.py )

الواجهة الخلفية مسؤولة عن التعامل مع إنشاء محتوى README. يتلقى مدخلات المستخدم ويعالجها ويتواصل مع نموذج الذكاء الاصطناعي التوليدي لإنشاء ملف README.

الواجهة الأمامية ( public/app.js )

توفر الواجهة الأمامية واجهة مستخدم تفاعلية للمستخدمين لإدخال تفاصيل مشروعهم وإنشاء ملف README. فهو يتواصل مع الواجهة الخلفية لإرسال مدخلات المستخدم واستقبال ملف README الذي تم إنشاؤه.

ابدء

لتشغيل README GPT؟ محليًا، اتبع الخطوات التالية:

1. استنساخ المستودع: git clone https://github.com/chiragjoshi12/readme-generator.git
2. انتقل إلى دليل المشروع: cd readme-generator
3. تثبيت التبعيات:
   • بالنسبة للواجهة الخلفية للقارورة:

      cd backend
     pip install -r requirements.txt
     

   • بالنسبة للواجهة الأمامية لـ Node.js:

      cd public
     npm install
     

4. إعداد متغيرات البيئة:
   • قم بإنشاء ملف .env في دليل backend وأضف مفتاح Geneative AI API الخاص بك:

      GENERATIVE_AI_API_KEY=your_api_key_here
     

5. ابدأ تشغيل خادم Flask: python app.py
6. ابدأ تشغيل خادم Node.js للواجهة الأمامية:

الاستخدام

1. افتح متصفح الويب الخاص بك وانتقل إلى http://localhost:3000 .
2. انقر على "إضافة ملف" لإدخال تفاصيل مشروعك.
3. املأ أقسام اسم الملف والرمز.
4. انقر فوق "إنشاء ملف README" لإنشاء ملف README الخاص بك.

؟ المساهمة

لا تتردد في المساهمة وتحسين هذا المشروع!

؟ اتصال

إذا كان لديك أي أسئلة أو اقتراحات، فلا تتردد في التواصل مع Chirag Joshi على [email protected].

---

مصنوع من ❤️ بواسطة شيراج جوشي

شكرًا لك على استخدام README GPT؟!