From a7ccc9166e6cbe7956b556a11b2eea81c4cc2db3 Mon Sep 17 00:00:00 2001 From: Greg Holmes Date: Wed, 18 Dec 2024 16:53:15 +0000 Subject: [PATCH] fixup! Add generate JWT authentication example --- .../javascript/.gitignore | 0 .../javascript/README.md | 6 +++--- .../javascript/index.html | 0 .../javascript/package.json | 2 +- .../javascript/src/script.ts | 0 .../javascript/src/styles.css | 0 .../javascript/tailwind.config.js | 0 .../javascript/tsconfig.json | 0 .../javascript/vite-env.d.ts | 0 .../javascript/vite.config.ts | 0 .../javascript/yarn.lock | 0 .../page.md | 16 ++++++++-------- .../react/.eslintrc.json | 0 .../react/.gitignore | 0 .../react/README.md | 6 +++--- .../react/next.config.mjs | 0 .../react/package.json | 0 .../react/postcss.config.mjs | 0 .../react/src/app/authenticated/page.tsx | 0 .../react/src/app/layout.tsx | 0 .../react/src/app/page.tsx | 0 .../react/styles/styles.css | 0 .../react/tailwind.config.ts | 0 .../react/tsconfig.json | 0 .../react/yarn.lock | 0 .../server/.env.example | 0 .../server/package.json | 0 .../server/src/server.ts | 0 .../server/tsconfig.json | 0 .../server/vite.config.ts | 0 .../server/yarn.lock | 0 31 files changed, 15 insertions(+), 15 deletions(-) rename examples/{auth-generate-token => auth-request-token}/javascript/.gitignore (100%) rename examples/{auth-generate-token => auth-request-token}/javascript/README.md (87%) rename examples/{auth-generate-token => auth-request-token}/javascript/index.html (100%) rename examples/{auth-generate-token => auth-request-token}/javascript/package.json (92%) rename examples/{auth-generate-token => auth-request-token}/javascript/src/script.ts (100%) rename examples/{auth-generate-token => auth-request-token}/javascript/src/styles.css (100%) rename examples/{auth-generate-token => auth-request-token}/javascript/tailwind.config.js (100%) rename examples/{auth-generate-token => auth-request-token}/javascript/tsconfig.json (100%) rename examples/{auth-generate-token => auth-request-token}/javascript/vite-env.d.ts (100%) rename examples/{auth-generate-token => auth-request-token}/javascript/vite.config.ts (100%) rename examples/{auth-generate-token => auth-request-token}/javascript/yarn.lock (100%) rename examples/{auth-generate-token => auth-request-token}/page.md (84%) rename examples/{auth-generate-token => auth-request-token}/react/.eslintrc.json (100%) rename examples/{auth-generate-token => auth-request-token}/react/.gitignore (100%) rename examples/{auth-generate-token => auth-request-token}/react/README.md (87%) rename examples/{auth-generate-token => auth-request-token}/react/next.config.mjs (100%) rename examples/{auth-generate-token => auth-request-token}/react/package.json (100%) rename examples/{auth-generate-token => auth-request-token}/react/postcss.config.mjs (100%) rename examples/{auth-generate-token => auth-request-token}/react/src/app/authenticated/page.tsx (100%) rename examples/{auth-generate-token => auth-request-token}/react/src/app/layout.tsx (100%) rename examples/{auth-generate-token => auth-request-token}/react/src/app/page.tsx (100%) rename examples/{auth-generate-token => auth-request-token}/react/styles/styles.css (100%) rename examples/{auth-generate-token => auth-request-token}/react/tailwind.config.ts (100%) rename examples/{auth-generate-token => auth-request-token}/react/tsconfig.json (100%) rename examples/{auth-generate-token => auth-request-token}/react/yarn.lock (100%) rename examples/{auth-generate-token => auth-request-token}/server/.env.example (100%) rename examples/{auth-generate-token => auth-request-token}/server/package.json (100%) rename examples/{auth-generate-token => auth-request-token}/server/src/server.ts (100%) rename examples/{auth-generate-token => auth-request-token}/server/tsconfig.json (100%) rename examples/{auth-generate-token => auth-request-token}/server/vite.config.ts (100%) rename examples/{auth-generate-token => auth-request-token}/server/yarn.lock (100%) diff --git a/examples/auth-generate-token/javascript/.gitignore b/examples/auth-request-token/javascript/.gitignore similarity index 100% rename from examples/auth-generate-token/javascript/.gitignore rename to examples/auth-request-token/javascript/.gitignore diff --git a/examples/auth-generate-token/javascript/README.md b/examples/auth-request-token/javascript/README.md similarity index 87% rename from examples/auth-generate-token/javascript/README.md rename to examples/auth-request-token/javascript/README.md index 51ec023a8e..cc90e4697d 100644 --- a/examples/auth-generate-token/javascript/README.md +++ b/examples/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 git@github.com: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/examples/auth-generate-token/javascript/index.html b/examples/auth-request-token/javascript/index.html similarity index 100% rename from examples/auth-generate-token/javascript/index.html rename to examples/auth-request-token/javascript/index.html diff --git a/examples/auth-generate-token/javascript/package.json b/examples/auth-request-token/javascript/package.json similarity index 92% rename from examples/auth-generate-token/javascript/package.json rename to examples/auth-request-token/javascript/package.json index 800866cb9a..e036e251df 100644 --- a/examples/auth-generate-token/javascript/package.json +++ b/examples/auth-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/examples/auth-generate-token/javascript/src/script.ts b/examples/auth-request-token/javascript/src/script.ts similarity index 100% rename from examples/auth-generate-token/javascript/src/script.ts rename to examples/auth-request-token/javascript/src/script.ts diff --git a/examples/auth-generate-token/javascript/src/styles.css b/examples/auth-request-token/javascript/src/styles.css similarity index 100% rename from examples/auth-generate-token/javascript/src/styles.css rename to examples/auth-request-token/javascript/src/styles.css diff --git a/examples/auth-generate-token/javascript/tailwind.config.js b/examples/auth-request-token/javascript/tailwind.config.js similarity index 100% rename from examples/auth-generate-token/javascript/tailwind.config.js rename to examples/auth-request-token/javascript/tailwind.config.js diff --git a/examples/auth-generate-token/javascript/tsconfig.json b/examples/auth-request-token/javascript/tsconfig.json similarity index 100% rename from examples/auth-generate-token/javascript/tsconfig.json rename to examples/auth-request-token/javascript/tsconfig.json diff --git a/examples/auth-generate-token/javascript/vite-env.d.ts b/examples/auth-request-token/javascript/vite-env.d.ts similarity index 100% rename from examples/auth-generate-token/javascript/vite-env.d.ts rename to examples/auth-request-token/javascript/vite-env.d.ts diff --git a/examples/auth-generate-token/javascript/vite.config.ts b/examples/auth-request-token/javascript/vite.config.ts similarity index 100% rename from examples/auth-generate-token/javascript/vite.config.ts rename to examples/auth-request-token/javascript/vite.config.ts diff --git a/examples/auth-generate-token/javascript/yarn.lock b/examples/auth-request-token/javascript/yarn.lock similarity index 100% rename from examples/auth-generate-token/javascript/yarn.lock rename to examples/auth-request-token/javascript/yarn.lock diff --git a/examples/auth-generate-token/page.md b/examples/auth-request-token/page.md similarity index 84% rename from examples/auth-generate-token/page.md rename to examples/auth-request-token/page.md index 3609ee9a7f..b2b26bc1a0 100644 --- a/examples/auth-generate-token/page.md +++ b/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 git@github.com: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 git@github.com: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/examples/auth-generate-token/react/.eslintrc.json b/examples/auth-request-token/react/.eslintrc.json similarity index 100% rename from examples/auth-generate-token/react/.eslintrc.json rename to examples/auth-request-token/react/.eslintrc.json diff --git a/examples/auth-generate-token/react/.gitignore b/examples/auth-request-token/react/.gitignore similarity index 100% rename from examples/auth-generate-token/react/.gitignore rename to examples/auth-request-token/react/.gitignore diff --git a/examples/auth-generate-token/react/README.md b/examples/auth-request-token/react/README.md similarity index 87% rename from examples/auth-generate-token/react/README.md rename to examples/auth-request-token/react/README.md index d9ccedd533..67b3226f58 100644 --- a/examples/auth-generate-token/react/README.md +++ b/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 git@github.com: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/examples/auth-generate-token/react/next.config.mjs b/examples/auth-request-token/react/next.config.mjs similarity index 100% rename from examples/auth-generate-token/react/next.config.mjs rename to examples/auth-request-token/react/next.config.mjs diff --git a/examples/auth-generate-token/react/package.json b/examples/auth-request-token/react/package.json similarity index 100% rename from examples/auth-generate-token/react/package.json rename to examples/auth-request-token/react/package.json diff --git a/examples/auth-generate-token/react/postcss.config.mjs b/examples/auth-request-token/react/postcss.config.mjs similarity index 100% rename from examples/auth-generate-token/react/postcss.config.mjs rename to examples/auth-request-token/react/postcss.config.mjs diff --git a/examples/auth-generate-token/react/src/app/authenticated/page.tsx b/examples/auth-request-token/react/src/app/authenticated/page.tsx similarity index 100% rename from examples/auth-generate-token/react/src/app/authenticated/page.tsx rename to examples/auth-request-token/react/src/app/authenticated/page.tsx diff --git a/examples/auth-generate-token/react/src/app/layout.tsx b/examples/auth-request-token/react/src/app/layout.tsx similarity index 100% rename from examples/auth-generate-token/react/src/app/layout.tsx rename to examples/auth-request-token/react/src/app/layout.tsx diff --git a/examples/auth-generate-token/react/src/app/page.tsx b/examples/auth-request-token/react/src/app/page.tsx similarity index 100% rename from examples/auth-generate-token/react/src/app/page.tsx rename to examples/auth-request-token/react/src/app/page.tsx diff --git a/examples/auth-generate-token/react/styles/styles.css b/examples/auth-request-token/react/styles/styles.css similarity index 100% rename from examples/auth-generate-token/react/styles/styles.css rename to examples/auth-request-token/react/styles/styles.css diff --git a/examples/auth-generate-token/react/tailwind.config.ts b/examples/auth-request-token/react/tailwind.config.ts similarity index 100% rename from examples/auth-generate-token/react/tailwind.config.ts rename to examples/auth-request-token/react/tailwind.config.ts diff --git a/examples/auth-generate-token/react/tsconfig.json b/examples/auth-request-token/react/tsconfig.json similarity index 100% rename from examples/auth-generate-token/react/tsconfig.json rename to examples/auth-request-token/react/tsconfig.json diff --git a/examples/auth-generate-token/react/yarn.lock b/examples/auth-request-token/react/yarn.lock similarity index 100% rename from examples/auth-generate-token/react/yarn.lock rename to examples/auth-request-token/react/yarn.lock diff --git a/examples/auth-generate-token/server/.env.example b/examples/auth-request-token/server/.env.example similarity index 100% rename from examples/auth-generate-token/server/.env.example rename to examples/auth-request-token/server/.env.example diff --git a/examples/auth-generate-token/server/package.json b/examples/auth-request-token/server/package.json similarity index 100% rename from examples/auth-generate-token/server/package.json rename to examples/auth-request-token/server/package.json diff --git a/examples/auth-generate-token/server/src/server.ts b/examples/auth-request-token/server/src/server.ts similarity index 100% rename from examples/auth-generate-token/server/src/server.ts rename to examples/auth-request-token/server/src/server.ts diff --git a/examples/auth-generate-token/server/tsconfig.json b/examples/auth-request-token/server/tsconfig.json similarity index 100% rename from examples/auth-generate-token/server/tsconfig.json rename to examples/auth-request-token/server/tsconfig.json diff --git a/examples/auth-generate-token/server/vite.config.ts b/examples/auth-request-token/server/vite.config.ts similarity index 100% rename from examples/auth-generate-token/server/vite.config.ts rename to examples/auth-request-token/server/vite.config.ts diff --git a/examples/auth-generate-token/server/yarn.lock b/examples/auth-request-token/server/yarn.lock similarity index 100% rename from examples/auth-generate-token/server/yarn.lock rename to examples/auth-request-token/server/yarn.lock