readme generator

Proyek Generator README

Ikhtisar Proyek

Selamat datang di proyek README Generator! Alat inovatif ini dirancang untuk menyederhanakan proses pembuatan file README untuk proyek perangkat lunak. Dengan memanfaatkan kekuatan AI generatif, pengguna dapat memasukkan deskripsi singkat tentang proyek mereka, termasuk tujuan, fitur, dan detail teknisnya, serta menghasilkan file README.md yang terstruktur dengan baik dan informatif dengan mengikuti praktik terbaik.

? Fitur

• Antarmuka yang Ramah Pengguna : Antarmuka web menyediakan cara intuitif untuk memasukkan detail proyek dan menghasilkan file README dengan mudah.
• Input File Dinamis : Pengguna dapat menambahkan banyak file dengan nama khusus dan cuplikan kode, memungkinkan dokumentasi komponen proyek yang komprehensif.
• Generasi README Dinamis : Secara otomatis menghasilkan file README berdasarkan input pengguna.
• Integrasi AI Generatif : Memanfaatkan model AI Generatif untuk menghasilkan file README berdasarkan masukan pengguna, memastikan akurasi dan relevansi.
• Konfigurasi yang Dapat Disesuaikan : Pengguna dapat mengonfigurasi pengaturan pembangkitan seperti suhu, p atas, k atas, dan pengaturan keselamatan untuk menyesuaikan keluaran sesuai dengan preferensi mereka.
• Konten yang Didukung AI : Memanfaatkan AI generatif untuk membuat konten yang menarik dan informatif.
• Dapat Disesuaikan : Memungkinkan pengguna untuk menyesuaikan file README sesuai dengan kebutuhan proyek mereka.
• Dukungan Emoji : Meningkatkan README dengan emoji untuk pengalaman pengguna yang lebih menarik.

Detail Teknis

Proyek README Generator dibangun dengan kombinasi Flask untuk backend dan Express.js untuk frontend. Ia menggunakan model AI Generatif Google untuk menghasilkan konten README, memastikan keluaran berkualitas tinggi dan relevan.

Bagian belakang ( app.py )

Backend bertanggung jawab menangani pembuatan konten README. Ia menerima masukan pengguna, memprosesnya, dan berkomunikasi dengan model AI generatif untuk menghasilkan README.

Bagian depan ( public/app.js )

Frontend menyediakan antarmuka pengguna interaktif bagi pengguna untuk memasukkan rincian proyek mereka dan menghasilkan README. Ia berkomunikasi dengan backend untuk mengirim input pengguna dan menerima README yang dihasilkan.

Memulai

Untuk menjalankan README GPT? secara lokal, ikuti langkah-langkah berikut:

1. Kloning repositori: git clone https://github.com/chiragjoshi12/readme-generator.git
2. Arahkan ke direktori proyek: cd readme-generator
3. Instal dependensi:
   • Untuk bagian belakang Flask:

      cd backend
     pip install -r requirements.txt
     

   • Untuk antarmuka Node.js:

      cd public
     npm install
     

4. Siapkan variabel lingkungan:
   • Buat file .env di direktori backend dan tambahkan kunci API AI Generatif Anda:

      GENERATIVE_AI_API_KEY=your_api_key_here
     

5. Mulai server Flask: python app.py
6. Mulai server Node.js untuk frontend:

Penggunaan

1. Buka browser web Anda dan navigasikan ke http://localhost:3000 .
2. Klik "Tambah File" untuk memasukkan detail proyek Anda.
3. Isikan pada bagian nama file dan kodenya.
4. Klik "Hasilkan README" untuk menghasilkan file README Anda.

? Berkontribusi

Jangan ragu untuk berkontribusi dan meningkatkan proyek ini!

? Kontak

Jika Anda memiliki pertanyaan atau saran, jangan ragu untuk menghubungi Chirag Joshi di [email protected].

---

Dibuat dengan ❤️ oleh Chirag Joshi

Terima kasih telah menggunakan README GPT?!