chore: add vercel example (#117)

* chore: initial vercel example

* chore: improved readme

* Update README.md

* Update README.md

* Update tsconfig.json

Author: yusinto

.prettierignore

@@ -6,3 +6,5 @@ node_modules/
 docs/
 .yarn
 coverage
+.next
+.vscode

package.json

@@ -7,7 +7,8 @@
     "packages/sdk/server-node",
     "packages/sdk/cloudflare",
     "packages/sdk/cloudflare/example",
-    "packages/sdk/vercel"
+    "packages/sdk/vercel",
+    "packages/sdk/example-vercel"
   ],
   "private": true,
   "scripts": {

packages/sdk/vercel/example-vercel/.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+.vscode

packages/sdk/vercel/example-vercel/README.md

@@ -0,0 +1,30 @@
+# Example test app for Vercel LaunchDarkly SDK
+
+This is an example test app to showcase the usage of the Vercel LaunchDarkly
+SDK. This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Prerequisites
+
+A node environment of version 16 and yarn are required to develop in this repository.
+You will also need the vercel cli installed and a Vercel account to setup
+the test data required by this example. See the [Vercel docs](https://vercel.com/docs/storage/edge-config/get-started) on how to setup your edge config store.
+
+## Usage
+
+1. Follow the [Vercel docs](https://vercel.com/docs/storage/edge-config/get-started) to insert [testData.json](https://github.com/launchdarkly/js-core/blob/main/packages/sdk/vercel/testData.json) to your edge config store.
+
+2. After completing the guide above, you should have linked this example app to your Vercel project and created an `.env.development.local`.
+
+3. At the root of the js-core repo:
+
+```shell
+yarn && yarn build
+```
+
+4. Then back in this example folder:
+
+```shell
+yarn dev
+```
+
+5. Open [http://localhost:3000/api/hello](http://localhost:3000/api/hello).

packages/sdk/vercel/example-vercel/next.config.js

@@ -0,0 +1,8 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {
+    appDir: true,
+  },
+};
+
+module.exports = nextConfig;

packages/sdk/vercel/example-vercel/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "example-vercel",
+  "version": "0.0.0",
+  "packageManager": "[email protected]",
+  "scripts": {
+    "dev": "next dev",
+    "build": "tsc",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@launchdarkly/vercel-server-sdk": "0.2.2",
+    "@vercel/edge-config": "^0.1.8",
+    "next": "13.3.1",
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "18.16.2",
+    "@types/react": "18.2.0",
+    "@types/react-dom": "18.2.1",
+    "autoprefixer": "10.4.14",
+    "postcss": "8.4.23",
+    "tailwindcss": "3.3.2",
+    "typescript": "5.0.4"
+  }
+}

packages/sdk/vercel/example-vercel/postcss.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+};

packages/sdk/vercel/example-vercel/public/next.svg

@@ -0,0 +1,37 @@
+import { NextResponse } from 'next/server';
+import { createClient } from '@vercel/edge-config';
+import { init as initLD } from '@launchdarkly/vercel-server-sdk';
+
+export const config = {
+  runtime: 'edge',
+};
+
+export async function GET() {
+  const sdkKey = 'test-sdk-key';
+  const flagKey = 'testFlag1';
+
+  // default fallthrough evaluates to true
+  const contextFallthrough = { kind: 'user', key: 'test-user-key-1' };
+
+  // matches email targeting rule evaluates to false
+  const contextEmailRule = { kind: 'user', key: 'test-user-key-1', email: '[email protected]' };
+
+  const vercelClient = createClient(process.env.EDGE_CONFIG);
+
+  // start using ld
+  const client = initLD(sdkKey, vercelClient);
+  await client.waitForInitialization();
+  const fallthrough = await client.variation(flagKey, contextFallthrough, false);
+  const emailRule = await client.variation(flagKey, contextEmailRule, false);
+  const flagDetail = await client.variationDetail(flagKey, contextEmailRule, false);
+  const allFlags = await client.allFlagsState(contextEmailRule);
+
+  return NextResponse.json({
+    flagKey: `${flagKey}`,
+    contextKey: `${contextFallthrough.key}`,
+    fallthrough,
+    emailRule,
+    emailRuleDetail: `${JSON.stringify(flagDetail)}`,
+    allFlags: `${JSON.stringify(allFlags)}`,
+  });
+}