Gambaran Umum
Cara mengatur alur kerja pengembangan LibreChat yang produktif.
Docker adalah jalur instalasi yang disarankan bagi sebagian besar pengguna, namun pengembangan LibreChat secara lokal sebaiknya menggunakan npm. Menjalankan aplikasi secara langsung di mesin Anda memberikan umpan balik yang lebih cepat, proses debugging yang lebih jelas, dan akses langsung ke workspace monorepo tanpa perlu membangun ulang container setelah setiap perubahan.
Rantai Alat yang Direkomendasikan
Gunakan toolchain ini untuk pengembangan berbasis npm:
| Alat | Versi |
|---|---|
| Node.js | v24.16.0 |
| npm | v11.16.0 |
| MongoDB | Atlas atau Community Server |
Node 24 memenuhi kebutuhan runtime LibreChat untuk interop CommonJS dengan paket-paket khusus ESM, WebCrypto, dan Fetch API. Jika shell Anda masih melaporkan versi Node yang lebih lama, jalankan nvm use 24.16.0 dari repositori LibreChat sebelum menginstal dependensi.
Bekerja di Ruang Kerja yang Tepat
LibreChat adalah sebuah monorepo. Pilih workspace terkecil yang memiliki perilaku yang ingin Anda ubah:
| Workspace | Gunakan untuk |
|---|---|
/packages/api | Layanan backend TypeScript baru, controller, dan logika server bersama |
/api | Integrasi server Express lama; buat perubahan seminimal mungkin |
/packages/data-schemas | Model basis data, skema, dan logika bersama khusus basis data |
/packages/data-provider | Tipe API bersama, endpoint, kunci kueri, dan fungsi layanan data |
/client | Kode aplikasi React |
/packages/client | Utilitas frontend bersama |
Perintah Harian
| Perintah | Tujuan |
|---|---|
npm run smart-reinstall | Menginstal dependensi saat diperlukan dan membangun workspace yang dikompilasi |
npm run reinstall | Instalasi bersih setelah mengubah versi Node/npm atau saat status dependensi mencurigakan |
npm run backend:dev | Memulai backend dengan pemantauan file |
npm run frontend:dev | Memulai server pengembangan frontend pada port 3090 |
npm run build:data-provider | Membangun ulang kode data-provider bersama setelah perubahan API/tipe |
npm run build | Membangun semua workspace yang dikompilasi melalui Turborepo |
Sumber Daya Pengembangan
Sumber Daya Pengembangan
- Jika Anda baru mengenal repositori, fork, branch, dan pull request, mulailah dengan panduan pengembangan kolaboratif GitHub.
- Baca Contributor Guidelines sebelum membuka PR.
- Gunakan Contributor Setup untuk alur pengaturan lokal lengkap.
- Gunakan Code Standards and Conventions untuk batasan ruang kerja, urutan impor, pengetikan, pengujian, dan aturan frontend.
Bagaimana panduan ini?