Unduh ReadMeAI - Unduh Kode Sumber ReadMeAI

ReadMeAI

Kode sumber lainnya

1.0.0

Unduh

? ReadMeai?

Ringkasan

Generator ReadMe adalah platform yang memungkinkan pengguna untuk mengunggah kode satu file dan menggambarkan proyek mereka. AI menghasilkan kode markdown, yang dapat diedit secara real-time menggunakan editor kode, dan perubahan dipratinjau secara instan.

ReadMeai sekarang langsung di ReadMeai.Live

Navigasi

? ReadMeai?
- Ringkasan
- Navigasi
- ? Fitur
- Struktur File (MVC)
- Tumpukan teknologi
- Instalasi
  - Di mesin lokal Anda
  - Di mesin virtual Anda (menggunakan Docker)
- Penggunaan
  - Di mesin lokal Anda
  - Menggunakan wadah Docker
- ? Fitur untuk rilis berikutnya.
- ?Mendukung
- ✍️ Penulis

? Fitur

Konten bertenaga AI : Menggunakan Google AI untuk menghasilkan konten yang bermakna dan informatif untuk ReadMe Anda, termasuk deskripsi proyek, penggunaan, instalasi, dan banyak lagi.
Kustomisasi : Anda dapat menyesuaikan konten yang dihasilkan menggunakan editor bawaan untuk memasukkan atau mengecualikan bagian tertentu, memastikan readme Anda mencerminkan kebutuhan unik proyek Anda.
Dukungan Markdown : File ReadME yang dihasilkan menggunakan Markdown, memudahkan untuk memformat dan menata dokumentasi proyek Anda.
Antarmuka web yang ramah pengguna : Akses generator melalui antarmuka web yang ramah pengguna, menghilangkan kebutuhan untuk pengaturan manual.

Struktur File (MVC)

? API/ : Berisi file kode untuk terhubung ke API pihak ketiga (Google Palm 2)
? Pengontrol/ : Berisi semua logika bisnis untuk dieksekusi berdasarkan permintaan pos/ mendapatkan.
? Views/ : Berisi file untuk diterjemahkan di sisi klien.
? Data/ : Berisi 'templat' yang akan menahan template output dan 'output.md' yang akan menandai penurunan harga.
? Publik/ : Berisi CSS dan skrip sisi klien.
? Rute/ : File untuk menangani rute dan untuk memanggil fungsi pengontrol masing -masing pada rute tertentu.
? Unggah/ : Direktori ini akan menyimpan file yang diterima server dari sisi klien, dan kemudian menghapusnya setelah sesi berakhir.
? Server.js : File ini adalah server Express utama, ini adalah file yang akan dijalankan pada server starting.
? DockerFile : File ini berisi skrip untuk proyek containerize.

Tumpukan teknologi

Node.js: Runtime sisi server.
Express: Node.js Framework.
? Google Palm API: Model bahasa Google Pathways adalah model bahasa besar berbasis transformator 540 miliar.
? EJS: Mesin templating untuk membuat dan menambahkan konten dinamis di HTML Anda di server.
? CSS: Styling The HTML Template.
JavaScript: Untuk menambahkan interaktivitas di frontend.

Instalasi

Di mesin lokal Anda

Klon Repositori.
Arahkan ke direktori proyek.
Buka Terminal Anda dan Jalankan:

    npm install

Di mesin virtual Anda (menggunakan Docker)

Kloning repo dan navigasikan ke direktori proyek.
Buka terminal dan ketik perintah berikut:

     docker build -t gitax18/readmeai .

Penggunaan

Di mesin lokal Anda

Ubah ke direktori proyek.
Buka terminal Anda dan ketik perintah berikut:

    npm start

Aplikasi akan berjalan di http: // localhost: 3333

Menggunakan wadah Docker

Untuk memulai wadah, ketik perintah berikut:

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

Sekarang aplikasi akan berjalan di http: // localhost: 3333

Catatan: Jika proyek tidak berjalan dengan benar dan menunjukkan kesalahan CRBUG di konsol web, ikuti langkah -langkah berikut.

Buka vScode An Go to 'Run and Debug' menu di bilah sisi kiri.
Klik 'Buat file launch.json' dan pilih Node.js di menu pop-up.
Sekarang klik ikon permainan segitiga hijau di bagian atas sidebar 'run and debug' yang sama.
Sekarang pergi ke http: // localhost: 3333

? Fitur untuk rilis berikutnya.

Otorisasi GitHub untuk menambahkan repo daripada file tunggal.
AI yang lebih terlatih untuk menghasilkan readme untuk folder daripada file.
Templat khusus, pengguna dapat menentukan fitur/bagian apa yang mereka inginkan dalam readme mereka.