Improve the Node.js quickstart developer experience #261

Activity

1. ejscribner

   assigned

   dex-the-ai

   on Oct 21, 2026
2. dex-the-ai commented on Oct 21, 2026

   

   dex-the-ai

   on Oct 21, 2026

   Contributor

   More actions

   Thanks for filing this. Before I open a PR I need a more specific target, because "easier to run successfully" could mean several different changes. Could you confirm which of these (or something else) you want, and what would count as done?

   1. Failure point: Which step is tripping up new users? For example: the Node version requirement (Babel 8 needs ^22.18.0 or >=24.11.0), copying and filling config/dev.env, loading travel-sample, Capella IP allow-listing and credentials, or self-managed / localhost connection strings.
   2. Fix type: Should this be a docs-only README cleanup, or are code changes in scope? Possible code changes include a startup preflight check with clear error messages for missing env vars, a wrong Node version, or an unreachable cluster or missing bucket; an .nvmrc / engines field; a one-command local setup such as Docker Compose with Couchbase Server and travel-sample; or a Dev Container / Codespaces config.
   3. Acceptance criteria: What should a new user be able to do, and how will we verify it? For example: "fresh clone, npm install && npm start against a local Couchbase Server with only dev.env filled in, and Swagger loads at /docs with no other steps."

   Once you pick a scope I'll implement it, validate it against a live cluster, and open a PR linking this issue.
3. ejscribner commented on Oct 21, 2026

   

   ejscribner

   on Oct 21, 2026

   ContributorAuthor

   More actions

   @dex-the-ai focus on local setup. Please add clearer README steps for running the app against a local Couchbase Server, including required environment variables, expected bucket/scope/collection setup, and a simple command or endpoint check to verify the app is working.
4. dex-the-ai commented on Oct 21, 2026

   

   dex-the-ai

   on Oct 21, 2026

   Contributor

   More actions

   Opened #262 with the local setup steps you asked for: a step-by-step "Running Against a Local Couchbase Server" section, an env var table, the expected travel-sample / inventory / airline, airport, route keyspaces, and a curl check on /api/v1/airline/airline_10 with the expected response and troubleshooting. I followed the steps against a fresh local Couchbase Server 7.6.4. npm test passed 20/20 and CI is green.