@upstash/redis 0.0.0-ci.bafaa360-20230119 → 0.0.0-ci.bb93ac2803c2e927dc8bf1a1b3c5aa2a14034eb6-20240930061920

package/examples/azure-functions/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/src/functions/*.js",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w",
+    "clean": "rimraf dist",
+    "prestart": "npm run clean && npm run build",
+    "start": "func start",
+    "test": "echo \"No tests yet...\""
+  },
+  "dependencies": {
+    "@azure/functions": "^4.0.0",
+    "@upstash/redis": "latest"
+  },
+  "devDependencies": {
+    "@types/node": "18.x",
+    "azure-functions-core-tools": "^4.x",
+    "rimraf": "^5.0.0",
+    "typescript": "^4.0.0"
+  }
+}

package/examples/azure-functions/src/functions/CounterFunction.ts

@@ -0,0 +1,19 @@
+import { app, HttpRequest, HttpResponseInit, InvocationContext } from "@azure/functions";
+import { Redis } from "@upstash/redis";
+
+const redis = new Redis({
+    url: process.env.UPSTASH_REDIS_REST_URL,
+    token: process.env.UPSTASH_REDIS_REST_TOKEN
+});
+
+export async function CounterFunction(request: HttpRequest, context: InvocationContext): Promise<HttpResponseInit> {
+    const count = await redis.incr("counter");
+
+    return { status: 200, body: `Counter: ${count}` };
+};
+
+app.http('CounterFunction', {
+    methods: ['GET', 'POST'],
+    authLevel: 'anonymous',
+    handler: CounterFunction
+});

package/examples/azure-functions/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es6",
+    "outDir": "dist",
+    "rootDir": ".",
+    "sourceMap": true,
+    "strict": false
+  }
+}

package/examples/cloudflare-workers/README.md

@@ -0,0 +1,26 @@
+# Cloudflare Workers Example
+
+This example uses
+[Wrangler](https://developers.cloudflare.com/workers/wrangler/) to create a
+javascript worker.
+
+## How to use
+
+1. Clone and install the example
+
+```bash
+git clone https://github.com/upstash/upstash-redis.git
+cd upstash-redis/examples/cloudflare-workers
+npm install
+```
+
+2. Create a free Database on [upstash.com](https://console.upstash.com/redis)
+3. Copy the `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` to
+   `wrangler.toml`
+4. Start the development server
+
+```bash
+npm run start
+```
+
+5. Open your browser at [localhost:8787](http://localhost:8787)

package/examples/cloudflare-workers/ci.test.ts

@@ -0,0 +1,18 @@
+import { expect, test } from "bun:test";
+
+const deploymentURL = process.env.DEPLOYMENT_URL;
+if (!deploymentURL) {
+  throw new Error("DEPLOYMENT_URL not set");
+}
+
+test("works", async () => {
+  console.log({ deploymentURL });
+  const url = `${deploymentURL}/`;
+  const res = await fetch(url);
+  if (res.status !== 200) {
+    console.log(await res.text());
+  }
+  expect(res.status).toEqual(200);
+  const json = (await res.json()) as { count: number };
+  expect(typeof json.count).toEqual("number");
+});

package/examples/cloudflare-workers/index.js

@@ -0,0 +1,11 @@
+import { Redis } from "@upstash/redis/cloudflare";
+
+export default {
+  async fetch(_request, env) {
+    const redis = Redis.fromEnv(env);
+
+    const count = await redis.incr("cloudflare-workers-count");
+
+    return new Response(JSON.stringify({ count }));
+  },
+};

package/examples/cloudflare-workers/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "cloudflare-workers",
+  "version": "1.0.0",
+  "description": "Example project using wrangler2",
+  "author": "Andreas Thomas <dev@chronark.com>",
+  "license": "MIT",
+  "scripts": {
+    "start": "wrangler dev",
+    "publish": "wrangler publish"
+  },
+  "devDependencies": {
+    "wrangler": "^2.20.0"
+  },
+  "dependencies": {
+    "@upstash/redis": "../../"
+  }
+}

package/examples/cloudflare-workers/wrangler.toml

@@ -0,0 +1,11 @@
+
+
+name = "upstash-redis"
+main = "index.js"
+compatibility_date = "2022-05-27"
+
+
+# Set variables here or on cloudflare
+# [vars]
+# UPSTASH_REDIS_REST_URL = "REPLACE_THIS"
+# UPSTASH_REDIS_REST_TOKEN = "REPLACE_THIS"

package/examples/cloudflare-workers-with-typescript/README.md

@@ -0,0 +1,26 @@
+# Cloudflare Worker Typescript Example
+
+This example uses
+[Wrangler](https://developers.cloudflare.com/workers/wrangler/) to create a
+typescript worker
+
+## How to use
+
+1. Clone and install the example
+
+```bash
+git clone https://github.com/upstash/upstash-redis.git
+cd upstash-redis/examples/cloudflare-workers-with-typescript
+npm install
+```
+
+2. Create a free Database on [upstash.com](https://console.upstash.com/redis)
+3. Copy the `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` to
+   `wrangler.toml`
+4. Start the development server
+
+```bash
+npm run start
+```
+
+5. Open your browser at [localhost:8787](http://localhost:8787)

package/examples/cloudflare-workers-with-typescript/ci.test.ts

@@ -0,0 +1,17 @@
+import {test, expect} from "bun:test"
+const deploymentURL = process.env.DEPLOYMENT_URL;
+if (!deploymentURL) {
+  throw new Error("DEPLOYMENT_URL not set");
+}
+
+test("works", async () => {
+  console.log({ deploymentURL });
+  const url = `${deploymentURL}/`;
+  const res = await fetch(url);
+  if (res.status !== 200) {
+    console.log(await res.text());
+  }
+  expect(res.status).toEqual(200);
+  const json = (await res.json()) as { count: number };
+  expect(typeof json.count).toEqual("number");
+});

package/examples/cloudflare-workers-with-typescript/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "cloudflare-workers-with-typescript",
+  "version": "0.0.0",
+  "devDependencies": {
+    "@cloudflare/workers-types": "^4.20221111.1",
+    "typescript": "^4.8.4",
+    "wrangler": "^2.4.4"
+  },
+  "private": true,
+  "scripts": {
+    "start": "wrangler dev",
+    "publish": "wrangler publish"
+  },
+  "dependencies": {
+    "@upstash/redis": "latest"
+  }
+}

package/examples/cloudflare-workers-with-typescript/src/index.ts

@@ -0,0 +1,16 @@
+import { Redis } from "@upstash/redis/cloudflare";
+
+export interface Env {
+  UPSTASH_REDIS_REST_URL: string;
+  UPSTASH_REDIS_REST_TOKEN: string;
+}
+
+export default {
+  async fetch(_request: Request, env: Env, _ctx: ExecutionContext): Promise<Response> {
+    const redis = Redis.fromEnv(env);
+
+    const count = await redis.incr("cloudflare-workers-with-typescript-count");
+
+    return new Response(JSON.stringify({ count }));
+  },
+};

package/examples/cloudflare-workers-with-typescript/tsconfig.json

@@ -0,0 +1,105 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2021", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "lib": [
+      "es2021"
+    ], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+    /* Modules */
+    "module": "es2022", /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    "types": [
+      "@cloudflare/workers-types"
+    ], /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    "resolveJsonModule": true, /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    "noEmit": true, /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
+    "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
+    // "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true, /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}

package/examples/cloudflare-workers-with-typescript/wrangler.toml

@@ -0,0 +1,9 @@
+name = "cloudflare-workers-with-typescript"
+main = "src/index.ts"
+compatibility_date = "2022-05-31"
+
+
+# Set variables here or on cloudflare
+# [vars]
+# UPSTASH_REDIS_REST_URL = "REPLACE_THIS"
+# UPSTASH_REDIS_REST_TOKEN = "REPLACE_THIS"

package/examples/deno/main.test.ts

@@ -0,0 +1,16 @@
+import { test, expect } from "bun:test";
+
+const deploymentURL = process.env.DEPLOYMENT_URL;
+if (!deploymentURL) {
+  throw new Error("DEPLOYMENT_URL not set");
+}
+
+test("works", async () => {
+  console.log({ deploymentURL });
+  const res = await fetch(deploymentURL);
+  const body = await res.text();
+  console.log({ body });
+  expect(res.status).toBe(200);
+  const json = JSON.parse(body) as { counter: number };
+  expect(typeof json.counter).toBe("number");
+});

package/examples/deno/main.ts

@@ -0,0 +1,9 @@
+import { serve } from "https://deno.land/std@0.177.0/http/server.ts";
+import { Redis } from "https://esm.sh/@upstash/redis@latest";
+
+serve(async (_req: Request) => {
+  const redis = Redis.fromEnv();
+  const counter = await redis.incr("deno deploy counter");
+
+  return new Response(JSON.stringify({ counter }), { status: 200 });
+});

package/examples/fastapi/README.md

@@ -0,0 +1,23 @@
+# FastAPI Example
+
+### Project Setup
+
+Clone the example and install dependencies
+
+```shell
+git clone https://github.com/upstash/redis-js.git
+cd redis-js/examples/fastapi
+pip install -r requirements.txt
+```
+
+### Database Setup
+
+Create a Redis database using [Upstash Console](https://console.upstash.com) or [Upstash CLI](https://github.com/upstash/cli) and export the `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` to your environment.
+
+```shell
+export UPSTASH_REDIS_REST_URL=<YOUR_URL>
+export UPSTASH_REDIS_REST_TOKEN=<YOUR_TOKEN>
+```
+
+### Run
+Run the app locally with `fastapi dev main.py`, check `http://127.0.0.1:8000/`

package/examples/fastapi/main.py

@@ -0,0 +1,12 @@
+from fastapi import FastAPI
+
+from upstash_redis import Redis
+
+app = FastAPI()
+
+redis = Redis.from_env()
+
+@app.get("/")
+def read_root():
+    count = redis.incr('counter')
+    return {"count": count}

package/examples/fastapi/requirements.txt

@@ -0,0 +1,2 @@
+fastapi
+upstash-redis

package/examples/fastly/README.md

@@ -0,0 +1,7 @@
+# Deploying to Fastly Compute
+
+You can use @upstash/redis in Fastly Compute as it accesses the Redis using REST
+calls.
+
+Check [this guide](https://blog.upstash.com/fastly-compute-edge-with-redis) for
+step by step instructions.

package/examples/fastly/fastly.toml

@@ -0,0 +1,12 @@
+# This file describes a Fastly Compute@Edge package. To learn more visit:
+# https://developer.fastly.com/reference/fastly-toml/
+
+authors = ["upstash"]
+description = "Example of using Upstash with Fastly Compute@Edge"
+language = "javascript"
+manifest_version = 2
+name = "fastly-upstash"
+service_id = "<SERVICE_ID>"
+
+[local_server.backends.upstash-db]
+url = "<UPSTASH_REDIS_REST_URL>"

package/examples/fastly/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "fastly-upstash-example",
+  "version": "0.2.0",
+  "main": "src/index.js",
+  "author": "woverton@fastly.com",
+  "license": "MIT",
+  "devDependencies": {
+    "core-js": "^3.19.1",
+    "webpack": "^5.74.0",
+    "webpack-cli": "^5.0.0"
+  },
+  "dependencies": {
+    "@fastly/js-compute": "^0.5.5",
+    "@upstash/redis": "latest",
+    "flight-path": "^1.0.10"
+  },
+  "scripts": {
+    "prebuild": "webpack",
+    "build": "js-compute-runtime  bin/index.js bin/main.wasm",
+    "deploy": "npm run build && fastly compute deploy",
+    "dev": "fastly compute serve --watch"
+  }
+}

package/examples/fastly/src/index.js

@@ -0,0 +1,19 @@
+import { Redis } from "@upstash/redis/fastly";
+
+addEventListener("fetch", (event) => event.respondWith(handleRequest(event)));
+
+async function handleRequest(_event) {
+  try {
+    const redis = new Redis({
+      url: "<UPSTASH_REDIS_REST_URL>",
+      token: "<UPSTASH_REDIS_REST_TOKEN>",
+      backend: "upstash-db", // same name you used in `fastly.toml`
+    });
+    const count = await redis.incr("fastly");
+    return new Response(JSON.stringify({ count }), {
+      headers: { "Content-Type": "application/json" },
+    });
+  } catch (err) {
+    return new Response(err.message, { status: 500 });
+  }
+}

package/examples/fastly/webpack.config.js

@@ -0,0 +1,28 @@
+const path = require("path");
+const webpack = require("webpack");
+
+module.exports = {
+  entry: "./src/index.js",
+  optimization: { minimize: true },
+  target: "webworker",
+  output: {
+    filename: "index.js",
+    path: path.resolve(__dirname, "bin"),
+    libraryTarget: "this",
+  },
+  module: {
+    // Asset modules are modules that allow the use asset files (fonts, icons, etc)
+    // without additional configuration or dependencies.
+    rules: [
+      // asset/source exports the source code of the asset.
+      // Usage: e.g., import notFoundPage from "./page_404.html"
+      { test: /\.(txt|html)/, type: "asset/source" },
+    ],
+  },
+  plugins: [
+    // Polyfills go here.
+    // Used for, e.g., any cross-platform WHATWG,
+    // or core nodejs modules needed for your application.
+    new webpack.ProvidePlugin({ URL: "core-js/web/url" }),
+  ],
+};

package/examples/google-cloud-functions/README.md

@@ -0,0 +1,37 @@
+# Google Cloud Functions Example
+
+### Prerequisites
+
+1. [Create a Google Cloud Project.](https://cloud.google.com/resource-manager/docs/creating-managing-projects)
+2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/verify-billing-enabled#console)
+3. Enable Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, Logging, and Pub/Sub APIs.
+4. [Install](https://cloud.google.com/sdk/docs/install) and [initialize](https://cloud.google.com/sdk/docs/initializing) the Google Cloud CLI.
+
+### Project Setup
+
+Clone the example
+
+```shell
+git clone https://github.com/upstash/redis-js.git
+cd redis-js/examples/google-cloud-functions
+```
+
+### Database Setup
+
+Create a Redis database using [Upstash Console](https://console.upstash.com) or [Upstash CLI](https://github.com/upstash/cli). Copy `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` for the next steps.
+
+### Deploy
+
+```shell
+gcloud functions deploy counter-function \
+--gen2 \
+--runtime=nodejs20 \
+--region=<YOUR_REGION> \
+--source=. \
+--entry-point=counter \
+--set-env-vars UPSTASH_REDIS_REST_URL=<YOUR_URL>,UPSTASH_REDIS_REST_TOKEN=<YOUR_TOKEN> \
+--trigger-http \
+--allow-unauthenticated
+```
+
+Visit the URL provided by the deployment to see the counter in action.

package/examples/google-cloud-functions/index.js

@@ -0,0 +1,12 @@
+const { Redis } = require("@upstash/redis");
+const functions = require('@google-cloud/functions-framework');
+
+const redis = new Redis({
+  url: process.env.UPSTASH_REDIS_REST_URL,
+  token: process.env.UPSTASH_REDIS_REST_TOKEN
+});
+
+functions.http('counter', async (req, res) => {
+  const count = await redis.incr("counter");
+  res.send("Counter:" + count);
+});

package/examples/google-cloud-functions/package.json

@@ -0,0 +1,7 @@
+{
+    "dependencies": {
+      "@google-cloud/functions-framework": "^3.0.0",
+      "@upstash/redis": "latest"
+    }
+  }
+  

package/examples/ion/.env.example

@@ -0,0 +1,2 @@
+UPSTASH_REDIS_REST_URL=
+UPSTASH_REDIS_REST_TOKEN=

package/examples/ion/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

package/examples/ion/README.md

@@ -0,0 +1,49 @@
+# Ion Example
+
+### Prerequisites
+
+You need to have AWS credentials configured locally and SST CLI installed.
+
+1. [Create an AWS account](https://aws.amazon.com/)
+2. [Create an IAM user](https://sst.dev/chapters/create-an-iam-user.html)
+3. [Configure the AWS CLI](https://sst.dev/chapters/configure-the-aws-cli.html)
+4. [Setup SST CLI](https://ion.sst.dev/docs/reference/cli/)
+
+### Project Setup
+
+Clone the example and install dependencies
+
+```shell
+git clone https://github.com/upstash/redis-js.git
+cd redis-js/examples/ion
+npm install
+```
+
+### Database Setup
+
+Create a Redis database using [Upstash Console](https://console.upstash.com) or [Upstash CLI](https://github.com/upstash/cli) and copy the `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` into your `.env` file.
+
+```shell .env
+UPSTASH_REDIS_REST_URL=<YOUR_URL>
+UPSTASH_REDIS_REST_TOKEN=<YOUR_TOKEN>
+```
+
+### Run
+
+Run the SST app.
+
+```shell
+sst dev next dev
+```
+
+Check `http://localhost:3000/`
+
+### Deploy
+
+Deploy with SST.
+
+```shell
+sst deploy
+```
+
+Check the output URL.