Beállítási referencia
Ezen az oldalon minden nem kötelező olvasmány – a Beállítás lefedi a normál útvonalat.
Host-managed setup
Futtasson mindent közvetlenül a hoston a devcontainer helyett. Ehhez Git, Node.js 24, Python 3.13 és Docker szükséges; a Docker futtatja a PostgreSQLt, a Redist és a MinIO-t.
- Futtassa a contributor bootstrap scriptet. A forkot állítja be
originremote-ként, azIntraCord-hq/IntraCordrepositoryt pedigupstreamremote-ként; inicializálja a Pipecat submodule-t, létrehozza a Python virtual environmentet, és bemásolja a.envtemplate-eket:
bash scripts/setup_fork.sh
.\scripts\setup_fork.ps1
- Aktiválja a virtuális környezetet:
source venv/bin/activate
.\venv\Scripts\Activate.ps1
- Python telepítési követelményei:
bash scripts/setup_requirements.sh --dev
.\scripts\setup_requirements.ps1 -Dev
- Telepítse a felhasználói felület függőségeit (győződjön meg arról, hogy a
node --version24-et jelent, például anvm use 24-n keresztül):
cd ui && npm install && cd ..
- Indítsa el a Postgres, Redis és MinIO alkalmazást:
docker compose -f docker-compose-local.yaml up -d
- Indítsa el a háttérprogramot:
bash scripts/start_services_dev.sh
.\scripts\start_services_dev.ps1
- Indítsa el a felhasználói felületet, majd nyissa meg a
http://localhost:3000fájlt:
cd ui && npm run dev
Devcontainer belső részei
A bejelentkezett .devcontainer/ a Dev Containers specifikációját követi, így Cursorban, JetBrains IDE-ben és más kompatibilis szerkesztőkben is működnie kell. Csak a VS Code elérési útját tesztelik aktívan – ha valami máshol elromlik, nyissa meg a GitHub-problémát.
Mit csinál a bootstrap
Amíg a container elindul, a devcontainer:
- Inicializálja a
pipecatgit submodule-t a hoston azinitializeCommandsegítségével - Elindítja a
postgres,redisésminioservice-eket Docker Compose-zal, majd megvárja, amíg healthy állapotba kerülnek - Feltölti a
venvnamed volume-ot az image-be épített Python 3.13 venvből - Editable módban újratelepíti a
pipecatpackage-et a bind-mounted submodule-ból, hogy a source editjei érvényesüljenek - Létrehozza az
api/.env,api/.env.testésui/.envfájlokat a megfelelő*.examplesablonokból, ha még nem léteznek - Lefuttatja az
npm ciparancsot aui/ésapi/mcp_server/ts_validator/könyvtárban
Az API env fájlokban a Postgres, Redis és MinIO localhost értékei a Docker network postgres, redis és minio aliasaira íródnak át. A MINIO_PUBLIC_ENDPOINT szándékosan localhost marad, mert a host böngészője innen tölti be az adatokat.
Mikor kell újjáépíteni a tartályt
A munkaterület kötési rögzítése és a venv / node_modules nevű kötetek a tároló újraindításakor is megmaradnak, így ritkán kell újraépíteni. Csak akkor építse újra, ha az alábbiak valamelyike megváltozik:
.devcontainer/Dockerfilevagy.devcontainer/devcontainer.jsonapi/requirements.txtvagyapi/requirements.dev.txt- A
pipecat/almodul
Az egyszerű forrású szerkesztések, a ui/package.json és a .env.example sablonok nem igényelnek újraépítést. A git pull után egy gyors ellenőrzés:
git diff HEAD@{1} HEAD -- .devcontainer api/requirements.txt api/requirements.dev.txt pipecat
Ha a diff üres, megtarthatja az aktuális tárolót.
Personal install hook
Bármi, amit a konténerben a named volume-okon kívül telepít — különösen a /home/vscode alatt — az újraépítéskor törlődik. Ide tartoznak az npm i -g csomagok és az olyan Toolok, mint a Claude vagy a Codex CLI.
A személyes tooling automatikus újratelepítéséhez hozzon létre egy végrehajtható .devcontainer/install.local.sh scriptet. A fájl gitignore-olva van, és a post-create bootstrap végén fut. Példa:
#!/usr/bin/env bash
set -euo pipefail
command -v claude >/dev/null 2>&1 || curl -fsSL https://claude.ai/install.sh | bash
command -v codex >/dev/null 2>&1 || npm i -g @openai/codex
A bejegyzéseket a command -v vagy egy markerfájl segítségével tartsa megőrizve, hogy az újrafuttatások olcsók és biztonságosak legyenek.
Dev Container CLI
A devcontainer VS-kód nélküli használatához egyszer telepítse a CLI-t a gazdagépen (Node.js szükséges):
npm install -g @devcontainers/cli
Indítsa el vagy építse újra a tárolót a lerakat gyökérkönyvtárából:
devcontainer up --workspace-folder .
Nyisson meg egy parancsértelmezőt a futó munkaterület-tárolóban:
devcontainer exec --workspace-folder . bash
Futtasson egy egyszeri parancsot a gazdagéptől, pl. a háttérrendszer vagy a felhasználói felület elindítása:
devcontainer exec --workspace-folder . bash scripts/start_services_dev.sh
devcontainer exec --workspace-folder . bash -lc 'cd ui && npm run dev -- --hostname 0.0.0.0'
Fork és upstream remote-ok
A contributor bootstrap (scripts/setup_fork.sh) két remote-ot konfigurál:
origin: az Ön forkja, ahová pusholupstream: azIntraCord-hq/IntraCordrepository, ahonnan a frissítéseket fetch-eli
Ha a saját forkja helyett közvetlenül az IntraCord-hq/IntraCord repositoryt klónozta, futtassa le egyszer a scriptet; ezt a devcontainerben is megteheti:
bash scripts/setup_fork.sh
Az upstream változások átvétele:
git fetch upstream
git checkout main
git merge upstream/main
git push origin main
A git remote -v paranccsal bármikor ellenőrizheti a remote-okat. A következőket kell látnia:
origin https://github.com/<YOUR_HANDLE>/IntraCord.git (fetch/push)
upstream https://github.com/IntraCord-hq/IntraCord.git (fetch/push)