fixup! Add generate JWT authentication example

ably · Dec 18, 2024 · a7ccc91 · a7ccc91
1 parent f91deaf
commit a7ccc91
Show file tree

Hide file tree

Showing 31 changed files with 15 additions and 15 deletions.
diff --git a/...auth-generate-token/javascript/.gitignore → .../auth-request-token/javascript/.gitignore b/...auth-generate-token/javascript/.gitignore → .../auth-request-token/javascript/.gitignore
diff --git a/.../auth-generate-token/javascript/README.md → ...s/auth-request-token/javascript/README.md b/.../auth-generate-token/javascript/README.md → ...s/auth-request-token/javascript/README.md
@@ -1,4 +1,4 @@
-# Generate an Ably token to authenticate clients
+# Generate an Ably Token to authenticate clients
 
 This folder contains the code for the authentication (Typescript) - a demo of how you can authenticate with [Ably](https://ably.com/docs/auth) to use any of the products.
 
@@ -13,7 +13,7 @@ git clone [email protected]:ably/docs.git
 2. Change directory:
 
 ```sh
-cd /examples/auth-generate-token/javascript/
+cd /examples/auth-request-token/javascript/
 ```
 
 3. Install dependencies:
@@ -31,7 +31,7 @@ yarn run dev
 5. In a new tab, change directory:
 
 ```sh
-cd /examples/auth-generate-token/server/
+cd /examples/auth-request-token/server/
 ```
 
 6. Rename the environment file:

diff --git a/...auth-generate-token/javascript/index.html → .../auth-request-token/javascript/index.html b/...auth-generate-token/javascript/index.html → .../auth-request-token/javascript/index.html
diff --git a/...th-generate-token/javascript/package.json → ...uth-request-token/javascript/package.json b/...th-generate-token/javascript/package.json → ...uth-request-token/javascript/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "auth-generate-token",
+  "name": "auth-request-token",
   "version": "1.0.0",
   "main": "index.js",
   "license": "MIT",

diff --git a/...h-generate-token/javascript/src/script.ts → ...th-request-token/javascript/src/script.ts b/...h-generate-token/javascript/src/script.ts → ...th-request-token/javascript/src/script.ts
diff --git a/...-generate-token/javascript/src/styles.css → ...h-request-token/javascript/src/styles.css b/...-generate-token/javascript/src/styles.css → ...h-request-token/javascript/src/styles.css
diff --git a/...erate-token/javascript/tailwind.config.js → ...quest-token/javascript/tailwind.config.js b/...erate-token/javascript/tailwind.config.js → ...quest-token/javascript/tailwind.config.js
diff --git a/...h-generate-token/javascript/tsconfig.json → ...th-request-token/javascript/tsconfig.json b/...h-generate-token/javascript/tsconfig.json → ...th-request-token/javascript/tsconfig.json
diff --git a/...h-generate-token/javascript/vite-env.d.ts → ...th-request-token/javascript/vite-env.d.ts b/...h-generate-token/javascript/vite-env.d.ts → ...th-request-token/javascript/vite-env.d.ts
diff --git a/...-generate-token/javascript/vite.config.ts → ...h-request-token/javascript/vite.config.ts b/...-generate-token/javascript/vite.config.ts → ...h-request-token/javascript/vite.config.ts
diff --git a/.../auth-generate-token/javascript/yarn.lock → ...s/auth-request-token/javascript/yarn.lock b/.../auth-generate-token/javascript/yarn.lock → ...s/auth-request-token/javascript/yarn.lock
diff --git a/examples/auth-generate-token/page.md → examples/auth-request-token/page.md b/examples/auth-generate-token/page.md → examples/auth-request-token/page.md
@@ -1,12 +1,12 @@
-# Generate an Ably token to authenticate clients
+# Request an Ably Token to authenticate clients
 
-Use an Ably token to securely authenticate users within your application.
+Use an Ably Token to securely authenticate your users.
 
-Ably tokens enable you to grant users access to the Ably platform. They are used to issue time-limited credentials that securely authorize users, and manage which resources each user has access to.
+Ably Tokens enable you to grant users access to the Ably platform. They are used to issue time-limited credentials that securely authorize users, and manage which resources each user has access to.
 
 Authentication is the first step for an application to communicate with Ably. The application initializes a client and calls a predefined `authUrl` endpoint on your backend server. This endpoint uses an API key to request a token from Ably and returns it to the requesting client. When the token nears expiry, the `authUrl` is automatically invoked to request a new token.
 
-Authentication is implemented using [Ably core Pub/Sub](https://ably.com/docs/auth). The Pub/Sub SDK provides authentication capabilities that are shared across all Ably products. The SDK includes purpose-built APIs that streamline pub/sub features while delivering Ably's performance guarantees and scaling capabilities.
+Authentication is implemented using [Ably Pub/Sub](https://ably.com/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products. It provides a set of flexible APIs capable of building any realtime application and is powered by Ably's reliable and scalable platform.
 
 ## Resources
 
@@ -43,7 +43,7 @@ git clone [email protected]:ably/docs.git
 2. Change directory:
 
 ```sh
-cd /examples/auth-generate-token/react/
+cd /examples/auth-request-token/react/
 ```
 
 3. Install dependencies:
@@ -61,7 +61,7 @@ yarn run dev
 5. In a new tab, change directory:
 
 ```sh
-cd /examples/auth-generate-token/server/
+cd /examples/auth-request-token/server/
 ```
 
 6. Rename the environment file:
@@ -97,7 +97,7 @@ git clone [email protected]:ably/docs.git
 2. Change directory:
 
 ```sh
-cd /examples/auth-generate-token/javascript/
+cd /examples/auth-request-token/javascript/
 ```
 
 3. Install dependencies:
@@ -115,7 +115,7 @@ yarn run dev
 5. In a new tab, change directory:
 
 ```sh
-cd /examples/auth-generate-token/server/
+cd /examples/auth-request-token/server/
 ```
 
 6. Rename the environment file:

diff --git a/.../auth-generate-token/react/.eslintrc.json → ...s/auth-request-token/react/.eslintrc.json b/.../auth-generate-token/react/.eslintrc.json → ...s/auth-request-token/react/.eslintrc.json
diff --git a/...ples/auth-generate-token/react/.gitignore → examples/auth-request-token/react/.gitignore b/...ples/auth-generate-token/react/.gitignore → examples/auth-request-token/react/.gitignore
diff --git a/examples/auth-generate-token/react/README.md → examples/auth-request-token/react/README.md b/examples/auth-generate-token/react/README.md → examples/auth-request-token/react/README.md
@@ -1,4 +1,4 @@
-# Generate a Ably token to authenticate clients
+# Generate a Ably Token to authenticate clients
 
 This folder contains the code for the authentication (React) - a demo of how you can authenticate with [Ably](https://ably.com/docs/auth) to use any of the products.
 
@@ -13,7 +13,7 @@ git clone [email protected]:ably/docs.git
 2. Change directory:
 
 ```sh
-cd /examples/auth-generate-token/react/
+cd /examples/auth-request-token/react/
 ```
 
 3. Install dependencies:
@@ -31,7 +31,7 @@ yarn run dev
 5. In a new tab, change directory:
 
 ```sh
-cd /examples/auth-generate-token/server/
+cd /examples/auth-request-token/server/
 ```
 
 6. Rename the environment file:

diff --git a/...auth-generate-token/react/next.config.mjs → .../auth-request-token/react/next.config.mjs b/...auth-generate-token/react/next.config.mjs → .../auth-request-token/react/next.config.mjs
diff --git a/...es/auth-generate-token/react/package.json → ...les/auth-request-token/react/package.json b/...es/auth-generate-token/react/package.json → ...les/auth-request-token/react/package.json
diff --git a/...h-generate-token/react/postcss.config.mjs → ...th-request-token/react/postcss.config.mjs b/...h-generate-token/react/postcss.config.mjs → ...th-request-token/react/postcss.config.mjs
diff --git a/...oken/react/src/app/authenticated/page.tsx → ...oken/react/src/app/authenticated/page.tsx b/...oken/react/src/app/authenticated/page.tsx → ...oken/react/src/app/authenticated/page.tsx
diff --git a/...h-generate-token/react/src/app/layout.tsx → ...th-request-token/react/src/app/layout.tsx b/...h-generate-token/react/src/app/layout.tsx → ...th-request-token/react/src/app/layout.tsx
diff --git a/...uth-generate-token/react/src/app/page.tsx → ...auth-request-token/react/src/app/page.tsx b/...uth-generate-token/react/src/app/page.tsx → ...auth-request-token/react/src/app/page.tsx
diff --git a/...th-generate-token/react/styles/styles.css → ...uth-request-token/react/styles/styles.css b/...th-generate-token/react/styles/styles.css → ...uth-request-token/react/styles/styles.css
diff --git a/...h-generate-token/react/tailwind.config.ts → ...th-request-token/react/tailwind.config.ts b/...h-generate-token/react/tailwind.config.ts → ...th-request-token/react/tailwind.config.ts
diff --git a/...s/auth-generate-token/react/tsconfig.json → ...es/auth-request-token/react/tsconfig.json b/...s/auth-generate-token/react/tsconfig.json → ...es/auth-request-token/react/tsconfig.json
diff --git a/examples/auth-generate-token/react/yarn.lock → examples/auth-request-token/react/yarn.lock b/examples/auth-generate-token/react/yarn.lock → examples/auth-request-token/react/yarn.lock
diff --git a/...s/auth-generate-token/server/.env.example → ...es/auth-request-token/server/.env.example b/...s/auth-generate-token/server/.env.example → ...es/auth-request-token/server/.env.example
diff --git a/...s/auth-generate-token/server/package.json → ...es/auth-request-token/server/package.json b/...s/auth-generate-token/server/package.json → ...es/auth-request-token/server/package.json
diff --git a/.../auth-generate-token/server/src/server.ts → ...s/auth-request-token/server/src/server.ts b/.../auth-generate-token/server/src/server.ts → ...s/auth-request-token/server/src/server.ts
diff --git a/.../auth-generate-token/server/tsconfig.json → ...s/auth-request-token/server/tsconfig.json b/.../auth-generate-token/server/tsconfig.json → ...s/auth-request-token/server/tsconfig.json
diff --git a/...auth-generate-token/server/vite.config.ts → .../auth-request-token/server/vite.config.ts b/...auth-generate-token/server/vite.config.ts → .../auth-request-token/server/vite.config.ts
diff --git a/...ples/auth-generate-token/server/yarn.lock → examples/auth-request-token/server/yarn.lock b/...ples/auth-generate-token/server/yarn.lock → examples/auth-request-token/server/yarn.lock