Tổng quan
Cách thiết lập quy trình phát triển LibreChat hiệu quả.
Docker là phương thức cài đặt được ưu tiên cho hầu hết người dùng, nhưng việc phát triển LibreChat cục bộ nên sử dụng npm. Chạy ứng dụng trực tiếp trên máy của bạn sẽ mang lại phản hồi nhanh hơn, gỡ lỗi rõ ràng hơn và quyền truy cập trực tiếp vào các workspace của monorepo mà không cần phải xây dựng lại các container sau mỗi thay đổi.
Chuỗi công cụ được đề xuất
Sử dụng chuỗi công cụ này để phát triển dựa trên npm:
| Công cụ | Phiên bản |
|---|---|
| Node.js | v24.16.0 |
| npm | v11.16.0 |
| MongoDB | Atlas hoặc Community Server |
Node 24 đáp ứng các yêu cầu về môi trường thực thi của LibreChat đối với khả năng tương tác CommonJS với các gói chỉ hỗ trợ ESM, WebCrypto và Fetch API. Nếu shell của bạn vẫn báo phiên bản Node cũ hơn, hãy chạy nvm use 24.16.0 từ thư mục lưu trữ LibreChat trước khi cài đặt các phụ thuộc.
Làm việc trong không gian làm việc phù hợp
LibreChat là một monorepo. Hãy chọn workspace nhỏ nhất sở hữu hành vi mà bạn đang thay đổi:
| Workspace | Sử dụng cho |
|---|---|
/packages/api | Các dịch vụ, bộ điều khiển (controller) TypeScript backend mới và logic máy chủ dùng chung |
/api | Tích hợp máy chủ Express cũ; giữ cho các thay đổi ở mức tối giản |
/packages/data-schemas | Các mô hình cơ sở dữ liệu, lược đồ (schema) và logic dùng chung cụ thể cho cơ sở dữ liệu |
/packages/data-provider | Các kiểu API dùng chung, endpoint, khóa truy vấn và các hàm dịch vụ dữ liệu |
/client | Mã nguồn ứng dụng React |
/packages/client | Các tiện ích frontend dùng chung |
Các lệnh hàng ngày
| Lệnh | Mục đích |
|---|---|
npm run smart-reinstall | Cài đặt các phụ thuộc khi cần thiết và xây dựng các không gian làm việc đã biên dịch |
npm run reinstall | Cài đặt sạch sau khi thay đổi phiên bản Node/npm hoặc khi trạng thái phụ thuộc không ổn định |
npm run backend:dev | Khởi động backend với tính năng theo dõi tệp |
npm run frontend:dev | Khởi động máy chủ phát triển frontend trên cổng 3090 |
npm run build:data-provider | Xây dựng lại mã data-provider dùng chung sau khi thay đổi API/kiểu dữ liệu |
npm run build | Xây dựng tất cả các không gian làm việc đã biên dịch thông qua Turborepo |
Tài nguyên phát triển
Tài nguyên phát triển
- Nếu bạn mới làm quen với các kho lưu trữ (repositories), fork, nhánh (branches) và pull request, hãy bắt đầu với hướng dẫn phát triển cộng tác của GitHub.
- Đọc Contributor Guidelines trước khi mở một PR.
- Sử dụng Contributor Setup để biết quy trình thiết lập cục bộ đầy đủ.
- Sử dụng Code Standards and Conventions cho các ranh giới không gian làm việc, thứ tự import, định kiểu, kiểm thử và các quy tắc frontend.
Hướng dẫn này thế nào?