myChat

myChat: Klon ChatGPT

myChat adalah proyek sumber terbuka yang meniru ChatGPT. Ini menyediakan antarmuka yang ramah pengguna untuk berinteraksi dengan LLM mirip GPT melalui OpenAI API. Proyek ini TIDAK berafiliasi langsung dengan OpenAI dengan cara apa pun.

Daftar isi

• Prasyarat
• Teknologi yang Digunakan
• Instalasi
• Pengaturan
• Penggunaan
• Penyebaran
• Berkontribusi
• Lisensi

Prasyarat

• Node.js >= 14
• Kunci API OpenAI
• Basis data MongoDB
• Contoh Redis

Teknologi yang Digunakan

• Next.js - Kerangka kerja berbasis React untuk membangun aplikasi web yang dirender di sisi server dan diekspor secara statis
• OpenAI LLMs - Model bahasa besar yang dikembangkan oleh OpenAI
• Tailwind CSS - Kerangka kerja CSS yang mengutamakan utilitas untuk membangun antarmuka pengguna khusus dengan cepat
• Axios - Perpustakaan populer untuk membuat permintaan HTTP dalam JavaScript
• NextAuth.js - Solusi otentikasi lengkap untuk aplikasi Next.js
• MongoDB - Database NoSQL populer yang digunakan untuk menyimpan informasi pengguna
• Mongoose - Pustaka Object Data Modeling (ODM) untuk MongoDB dan Node.js
• Redis - Penyimpanan struktur data dalam memori, digunakan sebagai database, cache, dan perantara pesan
• Kripto - Modul Node.js bawaan untuk menangani operasi kriptografi

Pengaturan

Pengaturan MongoDB

Kami menggunakan MongoDB untuk menyimpan informasi pengguna dan data sesi. Anda dapat menyiapkan instans MongoDB dengan beberapa cara:

• Unduh dan instal MongoDB langsung di mesin lokal Anda.
• Gunakan wadah Docker untuk menjalankan MongoDB.
• Gunakan layanan MongoDB terkelola, seperti MongoDB Atlas, yang menawarkan tingkat gratis.

Setelah Anda menjalankan instance MongoDB, Anda harus mendapatkan string koneksi. Jika Anda menggunakan MongoDB Atlas, Anda dapat menemukan string koneksi di pengaturan koneksi klaster Anda.

Tambahkan string koneksi MongoDB ke file .env.local Anda seperti:

Pengaturan Redis

Kami menggunakan Redis untuk membatasi tarif di rute API kami. Anda dapat menyiapkan instance Redis dengan beberapa cara, termasuk:

• Unduh dan instal Redis langsung di komputer lokal Anda (tidak disarankan untuk pengguna Windows).
• Gunakan wadah Docker untuk menjalankan Redis.
• Gunakan layanan Redis terkelola, seperti RedisLabs, yang menawarkan tingkat gratis.

Setelah Anda menjalankan instance Redis, Anda harus mendapatkan string koneksi. Jika Anda menggunakan RedisLabs, Anda dapat menemukan string koneksi di halaman konfigurasi database Anda.

Instalasi

1. Kloning repositori ini:

    git clone https://github.com/your-username/myChat.git
   

   atau mulai menggunakan fitur templat GitHub

2. Arahkan ke direktori proyek:

    cd myChat
   

3. Instal dependensi:

    npm install
   

4. Buat file .env.local di root proyek dan tambahkan variabel lingkungan yang diperlukan:

    touch .env.local
   

   Tambahkan yang berikut ini ke file .env.local :

    NEXTAUTH_URL=http://localhost:3000
   MONGODB_URI=yourURI
   NEXTAUTH_SECRET=yourSecret
   ENCRYPTION_KEY: a 32-digit hexadecimal string for AES-128 encryption (for users' API key)
   REDIS_URL=yourRedisConnectionString
   

Ganti http://localhost:3000 dengan port apa pun yang menjalankan aplikasi Anda, yourURI dengan string koneksi MongoDB Anda, yourSecret dengan string acak aman, your32HexDigitString dengan string heksadesimal 32 digit untuk enkripsi AES-128, dan yourRedisConnectionString dengan Redis Anda rangkaian koneksi.

...

Penggunaan

• Untuk menjalankan server pengembangan:

   npm run dev
  

• Untuk membangun aplikasi untuk produksi:

   npm run build
  

• Untuk memulai server produksi:

   npm run start
  

Penyebaran

Untuk menyebarkan Klon myChat Anda ke Vercel, ikuti langkah-langkah berikut:

1. Daftar akun Vercel jika Anda belum melakukannya.

2. Instal Vercel CLI:

    npm install -g vercel
   

3. Masuk ke akun Vercel Anda dari baris perintah:

    vercel login
   

4. Arahkan ke direktori proyek Anda:

    cd myChat
   

5. Jalankan perintah berikut untuk menyebarkan aplikasi Anda:

    vercel --prod
   

6. Selama proses penerapan, Vercel CLI akan menanyakan variabel lingkungan kepada Anda. Berikan nilai yang sama dengan yang Anda gunakan untuk file .env.local Anda:

    NEXTAUTH_URL: https://your-vercel-url.vercel.app
   MONGODB_URI: yourURI
   NEXTAUTH_SECRET: yourSecret
   ENCRYPTION_KEY: a 32-digit hexadecimal string for AES-128 encryption (for users' API key)
   REDIS_URL=yourRedisConnectionString
   

Ganti http://localhost:3000 dengan port apa pun yang menjalankan aplikasi Anda, yourURI dengan string koneksi MongoDB Anda, yourSecret dengan string acak aman, your32HexDigitString dengan string heksadesimal 32 digit untuk enkripsi AES-128, dan yourRedisConnectionString dengan Redis Anda rangkaian koneksi.

7. Setelah penerapan selesai, Vercel akan memberi Anda URL langsung untuk mengakses Klon myChat Anda.

Ingatlah bahwa setiap kali Anda membuat perubahan pada Klon myChat dan ingin menerapkan versi yang diperbarui, Anda cukup menjalankan vercel --prod dari direktori proyek.

Berkontribusi

Kami menyambut kontribusi! Untuk berkontribusi, silakan ikuti langkah-langkah berikut:

1. Garpu repositori ini
2. Kloning garpu Anda ke mesin lokal Anda: git clone https://github.com/your-username/myChat.git
3. Buat cabang fitur Anda: git checkout -b feature/my-new-feature atau git checkout -b fix/my-new-fix
4. Komit perubahan Anda: git commit -am 'Add some feature'
5. Dorong ke cabang: git push origin feature/my-new-feature
6. Kirimkan permintaan tarik

Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT.