From db3c2cea10878eef966ddc6bc1bf6adf918a60be Mon Sep 17 00:00:00 2001 From: dswbx Date: Fri, 11 Jul 2025 12:49:35 +0200 Subject: [PATCH] docs: add note about node.js 22 requirement --- docs/integration/astro.mdx | 5 +++++ docs/integration/nextjs.mdx | 7 +++++-- docs/integration/node.mdx | 6 ++++++ docs/integration/react-router.mdx | 5 +++++ docs/integration/vite.mdx | 5 +++++ docs/usage/database.mdx | 5 +++++ 6 files changed, 31 insertions(+), 2 deletions(-) diff --git a/docs/integration/astro.mdx b/docs/integration/astro.mdx index 2a6cc21..73c87a1 100644 --- a/docs/integration/astro.mdx +++ b/docs/integration/astro.mdx @@ -50,6 +50,11 @@ To get started with Astro and bknd you can either install the package manually, ## Configuration + + + When run with Node.js, a version of 22 (LTS) or higher is required. Please verify your version by running `node -v`, and [upgrade](https://nodejs.org/en/download/) if necessary. + + Now create a `bknd.config.ts` file in the root of your project. If you created the project using the CLI starter, this file is already created for you. ```typescript bknd.config.ts diff --git a/docs/integration/nextjs.mdx b/docs/integration/nextjs.mdx index 7f5fe96..251e650 100644 --- a/docs/integration/nextjs.mdx +++ b/docs/integration/nextjs.mdx @@ -4,6 +4,7 @@ description: 'Run bknd inside Next.js' --- import InstallBknd from '/snippets/install-bknd.mdx'; + ## Installation To get started with Next.js and bknd you can either install the package manually, and follow the descriptions below, or use the CLI starter: @@ -23,10 +24,12 @@ To get started with Next.js and bknd you can either install the package manually ## Configuration + + When run with Node.js, a version of 22 (LTS) or higher is required. Please verify your version by running `node -v`, and [upgrade](https://nodejs.org/en/download/) if necessary. + + Now create a `bknd.config.ts` file in the root of your project. If you created the project using the CLI starter, this file is already created for you. - - ```typescript bknd.config.ts import type { NextjsBkndConfig } from "bknd/adapter/nextjs"; diff --git a/docs/integration/node.mdx b/docs/integration/node.mdx index bf9803d..1bf6a4d 100644 --- a/docs/integration/node.mdx +++ b/docs/integration/node.mdx @@ -6,6 +6,7 @@ import InstallBknd from '/snippets/install-bknd.mdx'; ## Installation + To get started with Node and bknd you can either install the package manually, and follow the descriptions below, or use the CLI starter: @@ -24,6 +25,11 @@ To get started with Node and bknd you can either install the package manually, a ## Serve the API & static files + + + When run with Node.js, a version of 22 (LTS) or higher is required. Please verify your version by running `node -v`, and [upgrade](https://nodejs.org/en/download/) if necessary. + + The `serve` function of the Node adapter makes sure to also serve the static files required for the admin panel. diff --git a/docs/integration/react-router.mdx b/docs/integration/react-router.mdx index a0556d4..5f0d8e6 100644 --- a/docs/integration/react-router.mdx +++ b/docs/integration/react-router.mdx @@ -23,6 +23,11 @@ To get started with React Router and bknd you can either install the package man ## Configuration + + + When run with Node.js, a version of 22 (LTS) or higher is required. Please verify your version by running `node -v`, and [upgrade](https://nodejs.org/en/download/) if necessary. + + Now create a `bknd.config.ts` file in the root of your project. If you created the project using the CLI starter, this file is already created for you. ```typescript bknd.config.ts diff --git a/docs/integration/vite.mdx b/docs/integration/vite.mdx index 947984f..00f1856 100644 --- a/docs/integration/vite.mdx +++ b/docs/integration/vite.mdx @@ -17,6 +17,11 @@ npm install @hono/vite-dev-server ``` ## Configuration + + + When run with Node.js, a version of 22 (LTS) or higher is required. Please verify your version by running `node -v`, and [upgrade](https://nodejs.org/en/download/) if necessary. + + Now create a `bknd.config.ts` file in the root of your project. ```typescript bknd.config.ts diff --git a/docs/usage/database.mdx b/docs/usage/database.mdx index 8a43de3..6a2d863 100644 --- a/docs/usage/database.mdx +++ b/docs/usage/database.mdx @@ -69,6 +69,11 @@ Throughout the documentation, it is assumed you use `bknd.config.ts` to define y ## SQLite ### Using config object + + + When run with Node.js, a version of 22 (LTS) or higher is required. Please verify your version by running `node -v`, and [upgrade](https://nodejs.org/en/download/) if necessary. + + The `sqlite` adapter is automatically resolved based on the runtime. | Runtime | Adapter | In-Memory | File | Remote |