Configurazione per i collaboratori

Requisiti

• Git (Essenziale)
• Node.js v24.16.0 (Essenziale)
• npm v11.16.0 (Essenziale)
• MongoDB (Essenziale, per il database)
• Git LFS (Utile per file di grandi dimensioni)
• GitHub Desktop (Opzionale)
• VSCode (Editor di codice sorgente consigliato)

Estensioni VSCode consigliate

Installa queste estensioni in VS Code:

• Prettier
• ESLint
• GitLens

Prepara l'ambiente

Node.js e npm

Se utilizzi nvm, installa e seleziona la versione di Node.js raccomandata prima di installare LibreChat:

nvm install 24.16.0
nvm use 24.16.0
npm install -g [email protected]

Verifica che la tua shell stia utilizzando le versioni previste:

node -v
npm -v

v24.16.0
11.16.0

GitHub

• Effettua il fork del repository LibreChat: https://github.com/danny-avila/LibreChat/fork

• Crea un branch sul tuo fork, nominalo in modo appropriato e collegalo al repository originale.

• Scarica il tuo nuovo branch sul tuo PC locale

git clone -b branch-name https://github.com/username/LibreChat.git

Sostituisci branch-name e username con i tuoi dettagli

Apri in VS Code

• Dopo aver clonato il tuo branch:

  cd LibreChat

  code .

Preparare LibreChat

• Apri il terminale in VS Code con ctrl+shift+`

  In alternativa, usa ctrl+j per aprire il riquadro inferiore e seleziona il terminale.

• npm run smart-reinstall

  Se hai appena modificato le versioni di Node.js o npm, usa npm run reinstall una volta per un'installazione pulita.

• npm run build

• Configurazione di .env

  • Crea il file .env. Se non ne hai uno, duplica .env.example e configuralo.

Flusso di lavoro di sviluppo

Per un lavoro efficiente su LibreChat, utilizza questi comandi:

• Avvio del backend:

  • Usa npm run backend per il normale funzionamento.
  • Per lo sviluppo attivo, usa npm run backend:dev per monitorare le modifiche.
  • Accedi a http://localhost:3080/.

• Esecuzione del frontend in modalità di sviluppo:

  • Assicurati che il backend sia in esecuzione.
  • Usa npm run frontend:dev per monitorare le modifiche al frontend.
  • Visualizza su http://localhost:3090/.

Test locale

Prima dell'invio, testa i tuoi aggiornamenti localmente, vedi: Perform Tests Locally

Eseguendo i test, assicurati che i tuoi contributi siano robusti e pronti per l'integrazione.

Commit, Push, Pull Request (PR)

Esegui un Commit

I commit segnano punti di controllo logici nello sviluppo. Includi messaggi chiari che spieghino le modifiche.

Esempio:

git add .
git commit -m "Add login functionality"

Eseguire il push delle modifiche

Esegui il push delle modifiche al repository remoto dopo aver completato una funzionalità o aver risolto un problema.

Esempio:

git push origin feature-branch-name

Crea una Pull Request (PR)

Pull Request unisce le modifiche da un branch di funzionalità al branch principale.

1. Esegui il pull delle ultime modifiche dal branch main e risolvi i conflitti.
2. Esegui il push del branch della funzionalità aggiornato.
3. Assicurati che il codice segua le linee guida del progetto.

Esempio:

git checkout main
git pull origin main
git checkout feature-branch-name
git rebase main
# Resolve conflicts if any
git push origin feature-branch-name
# Open PR on GitHub

Accedi al tuo repository nel browser e clicca su "Contribute".

Ripristinare i commit in modo sicuro

Per annullare le modifiche in un feature branch, segui questi passaggi con cautela:

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  Sostituisci pick con drop per i commit da rimuovere. Salva ed esci dall'editor.

• git push --force-with-lease origin feature-branch-name