Skip to content

fix: align README with env-var setup and restore missing client-side ID guard #19

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

Draft
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: align README with env-var setup and restore missing client-side ID guard #19

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
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,15 @@ For a sample application demonstrating how to use LaunchDarkly in *server-side*

## Build instructions

1. Install the LaunchDarkly Client-Side Node.js SDK by running `npm install`
1. Set the environment variable `LAUNCHDARKLY_CLIENT_SIDE_ID` to your LaunchDarkly client-side ID. If there is an existing boolean feature flag in your LaunchDarkly project that you want to evaluate, set `LAUNCHDARKLY_FLAG_KEY` to the flag key; otherwise, a boolean flag of `sample-feature` will be assumed.

2. Edit `index.js` and set the value of `environmentId` to your LaunchDarkly client-side ID. If there is an existing boolean feature flag in your LaunchDarkly project that you want to evaluate, set `featureFlagKey` to the flag key.
```bash
export LAUNCHDARKLY_CLIENT_SIDE_ID="1234567890abcdef"
export LAUNCHDARKLY_FLAG_KEY="my-boolean-flag"
```

```js
const environmentId = "1234567890abcdef";

const featureFlagKey = "my-flag";
```
2. Install the LaunchDarkly Client-Side Node.js SDK by running `npm install`

3. Run `node index.js`

You should see the message `"Feature flag '<flag key>' is <true/false> for this user"`.
You should receive the message "The '<flagKey>' feature flag evaluates to <flagValue>.". The application will run continuously and react to the flag changes in LaunchDarkly.
2 changes: 1 addition & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const LaunchDarkly = require('launchdarkly-node-client-sdk');

// Set clientSideId to your LaunchDarkly client-side ID.
const clientSideId = process.env.LAUNCHDARKLY_CLIENT_SIDE_ID ?? 'your-client-side-id';
const clientSideId = process.env.LAUNCHDARKLY_CLIENT_SIDE_ID ?? '';

// Set featureFlagKey to the feature flag key you want to evaluate.
const featureFlagKey = process.env.LAUNCHDARKLY_FLAG_KEY ?? 'sample-feature';
Expand Down