ReadMeAI

؟ ReadMeai؟

ملخص

مولد README هو منصة تتيح للمستخدمين تحميل رمز ملف واحد ووصف مشروعهم. يقوم AI بإنشاء رمز تخفيض ، يمكن تحريره في الوقت الفعلي باستخدام محرر التعليمات البرمجية ، ويتم معاينة التغييرات على الفور.

READMEAI يعيش الآن على readmeai.live

ملاحة

• ؟ ReadMeai؟
  • ملخص
  • ملاحة
  • ؟ سمات
  • بنية الملف (MVC)
  • مكدس التكنولوجيا
  • تثبيت
    • في جهازك المحلي
    • في جهازك الظاهري (باستخدام Docker)
  • الاستخدام
    • في جهازك المحلي
    • باستخدام حاوية Docker
  • ؟ ميزات الإصدار التالي.
  • ؟يدعم
  • ✍ المؤلفون

؟ سمات

• المحتوى الذي يعمل بذاكرة الذكاء الاصطناعى : يستخدم Google AI لإنشاء محتوى ذي معنى وغني بالمعلومات لـ ReadMe ، بما في ذلك وصف المشروع ، والاستخدام ، والتثبيت ، وأكثر من ذلك.

• التخصيص : يمكنك تخصيص المحتوى الذي تم إنشاؤه باستخدام محرر مدمج لتضمين أو استبعاد أقسام محددة ، مما يضمن أن ReadMe يعكس احتياجات مشروعك الفريدة.

• دعم Markdown : تستخدم ملفات ReadMe التي تم إنشاؤها Markdown ، مما يجعل من السهل تنسيق وثائق مشروعك.

• واجهة ويب سهلة الاستخدام : الوصول إلى المولد من خلال واجهة ويب سهلة الاستخدام ، مما يلغي الحاجة إلى الإعداد اليدوي.

بنية الملف (MVC)

• ؟ API/ : يحتوي على ملف رمز للاتصال بجهات خارجية API (Google Palm 2)
• ؟ وحدات التحكم/ : يحتوي على جميع منطق العمل لتنفيذها على الطلبات/ الحصول على الطلبات.
• ؟ طرق العرض/ : يحتوي على ملفات لتقديمها على جوانب العميل.
• ؟ Data/ : يحتوي على "القالب" الذي سيحمل قالب الإخراج و "output.md" الذي سيؤدي إلى الإخراج.
• ؟ عام/ : يحتوي على جانب العميل CSS والبرامج النصية.
• ؟ الطرق/ : ملف لمعالجة الطرق واستدعاء وظيفة وحدة التحكم المعنية على مسار معين.
• ؟ تحميل/ : سيحتفظ هذا الدليل بالملفات التي تلقاها الخادم من جانب العميل ، ثم يحذفها بمجرد انتهاء الجلسة.
• ؟ Server.js : هذا الملف هو خادم Express الرئيسي ، هذا هو الملف الذي سيتم تنفيذه على Server Server.
• ؟ Dockerfile : يحتوي هذا الملف على برنامج نصي لإعداد حاوية المشروع.

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

• Node.js: وقت التشغيل من جانب الخادم.
• Express: Node.JS Framework.
• ؟ Google Palm API: نموذج لغة Google Pathways هو نموذج لغة كبير قائم على محول المعلمات 540 مليار.
• ؟ EJS: محرك templating لتقديم وإضافة محتوى ديناميكي في HTML الخاص بك في الخادم.
• ؟ CSS: تصميم قالب HTML.
• JavaScript: لإضافة التفاعل في الواجهة الأمامية.

تثبيت

في جهازك المحلي

1. استنساخ المستودع.
2. انتقل إلى دليل المشروع.
3. افتح المحطة الخاصة بك وتشغيله:

    npm install

في جهازك الظاهري (باستخدام Docker)

1. استنساخ الريبو وانتقل إلى دليل المشروع.
2. افتح الجهاز واكتب الأمر التالي:

     docker build -t gitax18/readmeai . 

الاستخدام

في جهازك المحلي

1. تغيير إلى دليل المشروع.
2. افتح المحطة الخاصة بك واكتب الأمر التالي:

    npm start

3. سيتم تشغيل التطبيق على http: // localhost: 3333

باستخدام حاوية Docker

1. لبدء الحاوية ، اكتب الأمر التالي:

    docker run -it -p 3333:3333 gitax18/readmeai

2. الآن سيتم تشغيل التطبيق على http: // localhost: 3333

---

ملاحظة: إذا لم يتم تشغيل المشروع بشكل صحيح وأظهر خطأ CRBUG في وحدة التحكم على الويب ، فاتبع الخطوات التالية.

1. افتح VScode A Go to "Run and Debug" في الشريط الجانبي الأيسر.
2. انقر فوق "إنشاء ملف laffic.json" وحدد Node.js في القائمة المنبثقة.
3. انقر الآن على أيقونة تشغيل Green Triangular في الجزء العلوي من الشريط الجانبي "Run and Debug".
4. انتقل الآن إلى http: // localhost: 3333

؟ ميزات الإصدار التالي.

• ترخيص GitHub لإضافة repo بدلاً من ملف واحد.
• أكثر من الذكاء الاصطناعي تدريب لإنشاء ReadMe للمجلدات بدلاً من الملف.
• قوالب مخصصة ، يمكن للمستخدم تحديد الميزات/القسم الذي يريدونه في ReadMe.

؟يدعم

إذا واجهت أي مشكلات أو لديك أسئلة ، فلا تتردد في إنشاء مشكلة في المستودع. نحن هنا للمساعدة!

✍ المؤلفون

• Gitanshu Sankhla (مطور الخلفي) -

• فيجاي بانجارا (مطور الواجهة) -
  

• هارش كومار (مصمم) -