Skip to content

Update deps and clean quickstart drift #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dex-the-ai wants to merge 1 commit into from
Closed

Update deps and clean quickstart drift #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,18 @@ Specifically, you need to do the following:

All configuration for communication with the database is read from the environment variables. We have provided a convenience feature in this quickstart to read the environment variables from a local file, `dev.env` in the `config` folder.

```sh
cp config/dev.env.example config/dev.env
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The npm test script in package.json is configured to use ./config/test.env. Since you are now explicitly instructing users to create config/dev.env from the example file, you should also include the command to create config/test.env. This ensures that users can run the integration tests locally without encountering errors about missing environment files.

Suggested change
cp config/dev.env.example config/dev.env
cp config/dev.env.example config/dev.env
cp config/test.env.example config/test.env

```

Then update `config/dev.env` with your cluster details:

```sh
DB_CONN_STR=<connection_string>
DB_USERNAME=<user_with_read_write_permission_to_travel-sample_bucket>
DB_PASSWORD=<password_for_user>
DB_BUCKET_NAME=travel-sample
APP_PORT=3000
```

> Note: The connection string expects the `couchbases://` or `couchbase://` part.
Expand Down
2 changes: 0 additions & 2 deletions config/dev.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@ DB_CONN_STR=couchbases://<identifier>.cloud.couchbase.com
DB_USERNAME=
DB_PASSWORD=
DB_BUCKET_NAME=travel-sample
IS_CAPELLA=true
APP_PORT=3000
DELAY=5000
2 changes: 0 additions & 2 deletions config/test.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@ DB_CONN_STR=couchbases://<identifier>.cloud.couchbase.com
DB_USERNAME=
DB_PASSWORD=
DB_BUCKET_NAME=travel-sample
IS_CAPELLA=true
APP_PORT=3000
DELAY=5000
Loading
Loading