Bootstrap script#160
Open
jspada200 wants to merge 3 commits into
Open
Conversation
Adds a single interactive script at the repo root that walks a new contributor through the full local setup in one command: - Checks that npm and Docker (daemon running) are present - Backs up and copies all three example config files (docker-compose.local.yml, docker-compose.local.vexa.yml, frontend .env) - Interactively prompts for the LLM provider and API key (OpenAI / Gemini / skip) - Interactively prompts for the transcription backend: remote vexa.ai free tier, self-hosted Whisper service, or skip (adds SKIP_TRANSCRIPTION_CHECK=true when skipped) - Runs npm install for the frontend - Starts the Vexa services, waits for readiness, creates a local user, generates a Vexa API key, and writes it into docker-compose.local.yml - Starts the full DNA stack detached (equivalent to make start-local) Compatible with macOS and Linux. Re-runnable: existing config files are backed up with a timestamp suffix before being overwritten. Also updates .gitignore files to exclude the .bak.* backup files the script creates. Signed-off-by: James Spadafora <spadjv@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: James Spadafora <spadjv@gmail.com>
jspada200
requested review from
camerontarget14 and
loorthu
and removed request for
camerontarget14
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
New contributors have reported difficulty getting the stack running locally. This PR adds a single interactive
bootstrap.shscript at the repo root that automates the entire first-time setup in one command.The script handles:
npmanddockerare installed and the Docker daemon is running, with actionable error messages for each failure.bak.*) then copies all three example configs:docker-compose.local.yml,docker-compose.local.vexa.yml, andfrontend/packages/app/.envSKIP_TRANSCRIPTION_CHECK=trueso Vexa starts cleanly)npm installinfrontend/VEXA_API_KEYintodocker-compose.local.ymlautomaticallymake start-localin detached modeThe script is re-runnable: if config files already exist they are backed up before being overwritten. The
.gitignorefiles are updated to exclude the.bak.*files the script produces.Compatible with macOS and Linux.
Testing
How I Tested
Ran
./bootstrap.shon Linux (WSL2) end-to-end:docker-compose.local.ymldocker-compose.local.vexa.ymlnpm installcomplete successfully:8056VEXA_API_KEYinjected intodocker-compose.local.ymldocker compose up --build -dAlso verified:
SKIP_TRANSCRIPTION_CHECK=truetodocker-compose.local.vexa.ymland Vexa starts without the 403 errorbash -n bootstrap.sh8056(the gateway port accessible from the host;8057is internal Docker-network only)