Add Node.js support to documentation

Update documentation and build configuration to reflect Node.js support
alongside Deno. Switch docs build from Bun to pnpm for consistency.

Co-Authored-By: Claude <noreply@anthropic.com>

Author: dahlia

.github/workflows/main.yaml

@@ -127,12 +127,15 @@ jobs:
       url: ${{ steps.deploy.outputs.page_url }}
     steps:
     - uses: actions/checkout@v4
-    - uses: oven-sh/setup-bun@v2
+    - uses: actions/setup-node@v4
+      with:
+        node-version: latest
+    - uses: pnpm/action-setup@v4
       with:
-        bun-version: latest
-    - run: bun install
+        version: 10
+    - run: pnpm install
       working-directory: docs
-    - run: bun run build
+    - run: pnpm build
       env:
         PLAUSIBLE_DOMAIN: ${{ vars.PLAUSIBLE_DOMAIN }}
         SITEMAP_HOSTNAME: https://${{ vars.PLAUSIBLE_DOMAIN }}

.vscode/settings.json

@@ -67,6 +67,7 @@
     "pico",
     "Pixelfed",
     "smallweb",
+    "srvx",
     "Tailscale",
     "tsdown",
     "unfollow",

README.md

@@ -4,15 +4,11 @@
 ==================
 
 [![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
 [![GitHub Actions][GitHub Actions badge]][GitHub Actions]
 [![Codecov][Codecov badge]][Codecov]
 [![Fediverse][Fediverse badge]][Fediverse]
 
-> [!NOTE]
-> BotKit is still in early development.  The API may change in the future.
-> Although it currently supports only Deno, it will support Node.js and Bun
-> later.
-
 [BotKit] is a framework for creating [ActivityPub] bots.  It is powered by
 [Fedify], a lower-level library for creating ActivityPub server applications.
 Unlike Mastodon bots, BotKit is designed to create a standalone ActivityPub bot,
@@ -63,6 +59,8 @@ For more information, see the [BotKit docs][BotKit].
 [BotKit]: https://botkit.fedify.dev/
 [JSR]: https://jsr.io/@fedify/botkit
 [JSR badge]: https://jsr.io/badges/@fedify/botkit
+[npm]: https://www.npmjs.com/package/@fedify/botkit
+[npm badge]: https://img.shields.io/npm/v/@fedify/botkit?logo=npm
 [GitHub Actions]: https://github.com/fedify-dev/botkit/actions/workflows/main.yaml
 [GitHub Actions badge]: https://github.com/fedify-dev/botkit/actions/workflows/main.yaml/badge.svg
 [Codecov]: https://codecov.io/gh/fedify-dev/botkit

docs/.vitepress/config.mts

@@ -84,6 +84,11 @@ export default defineConfig({
         link: "https://jsr.io/@fedify/botkit",
         ariaLabel: "JSR",
       },
+      {
+        icon: "npm",
+        link: "https://www.npmjs.com/package/@fedify/botkit",
+        ariaLabel: "npm",
+      },
       {
         icon: "discord",
         link: "https://discord.gg/bhtwpzURwd",

docs/bun.lock

@@ -320,7 +320,14 @@ Running the bot
 
 After you have instantiated a `Bot` object, you need to connect it to
 the HTTP server to run it.  The `Bot` object comply with the [`fetch()`] API,
-so you can use it as a request handler for the [`deno serve`] command.
+so you can use it as a request handler for the [`deno serve`] command on Deno
+or [srvx] on Node.js.
+
+[`fetch()`]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[`deno serve`]: https://docs.deno.com/runtime/reference/cli/serve/
+[srvx]: https://srvx.h3.dev/
+
+### Deno
 
 For example, if you have a `Bot` object named `bot`, and `export` it as
 a default export:
@@ -356,8 +363,53 @@ And your bot will be available at <http://localhost:8000/>.
 > deno serve -A --port=3000 ./bot.ts
 > ~~~~
 
-[`fetch()`]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
-[`deno serve`]: https://docs.deno.com/runtime/reference/cli/serve/
+### Node.js
+
+In Node.js, you should use the [srvx] package to run the bot.  First, you need
+to install the *srvx* package:
+
+::: code-group
+
+~~~~ bash [npm]
+npm add srvx
+~~~~
+
+~~~~ bash [pnpm]
+pnpm add srvx
+~~~~
+
+~~~~ bash [Yarn]
+yarn add srvx
+~~~~
+
+:::
+
+Then, import [`serve()`] function from `srvx` module:
+
+~~~~ typescript [bot.ts]
+import { serve } from "srvx";
+~~~~
+
+Finally, you can run the bot using the [`serve()`] function at the end of
+the *bot.ts* file:
+
+~~~~ typescript [bot.ts]
+const server = serve({
+  ...bot,
+  port: 8000,
+});
+await server.ready();
+console.log(`Bot is running at ${server.url}`);
+~~~~
+
+Then, you can run the bot using the following command:
+
+~~~~ bash
+node --experimental-transform-types ./bot.ts
+~~~~
+
+The above command will start the bot and it will be available at
+<http://localhost:8000/>:
 
 ### Exposing the bot to the public internet
 
@@ -384,17 +436,23 @@ const bot = createBot<void>({
   // Omitted other options for brevity
   behindProxy: BEHIND_PROXY,
 });
-
-export default bot;
 ~~~~
 
 Then, you can use the following command to run the bot with the `BEHIND_PROXY`
 environment variable set to `true`:
 
-~~~~ bash
+::: code-group
+
+~~~~ bash [Deno]
 BEHIND_PROXY=true deno serve -A --port 8000 ./bot.ts
 ~~~~
 
+~~~~ bash [Node.js]
+node --experimental-transform-types ./bot.ts
+~~~~
+
+:::
+
 Then, you can use the tunneling service to expose your bot to the public
 internet, for example, with [`fedify tunnel`]:[^1]
 

docs/concepts/bot.md

@@ -119,11 +119,7 @@ BotKit currently supports deployment through:
 
  -  [Deno Deploy] for serverless hosting
  -  Docker containers on platforms like Fly.io and Railway
- -  Self-hosted Deno runtime on your own server
-
-> [!NOTE]
-> While Node.js and Bun support are planned for future releases,
-> the current version requires Deno.
+ -  Self-hosted Node.js or Deno runtime on your own server
 
 [Deno Deploy]: https://deno.com/deploy
 

docs/intro.md

@@ -6,48 +6,19 @@ description: >-
 Getting started
 ===============
 
-Installing Deno
----------------
-
-> [!NOTE]
-> BotKit currently supports only [Deno].  Once BotKit is more stable, we will
-> support [Node.js] and [Bun].
-
-BotKit is a TypeScript framework written in Deno.  To install BotKit, you need
-to have Deno 2 or higher installed on your machine.  There are [multiple ways to
-install Deno][1], but the easiest way is to use the following command:
-
-::: code-group
-
-~~~~ bash [Linux]
-curl -fsSL https://deno.land/install.sh | sh
-~~~~
-
-~~~~ zsh [macOS]
-curl -fsSL https://deno.land/install.sh | sh
-~~~~
-
-~~~~ powershell [Windows]
-irm https://deno.land/install.ps1 | iex
-~~~~
-
-:::
-
-[Deno]: https://deno.com/
-[Node.js]: https://nodejs.org/
-[Bun]: https://bun.sh/
-[1]: https://docs.deno.com/runtime/getting_started/installation/
-
 
 Installing BotKit
 -----------------
 
-Once you have Deno installed, you need to create a new project for your bot and
-install BotKit as a dependency:
+BotKit is available for both Node.js and Deno.  You can install BotKit
+depending on your environment.
+
+### Deno
+
+You need to create a new project for your bot and install BotKit as
+a dependency:
 
 ~~~~ bash
-mkdir my-bot/
-cd my-bot/
 deno add jsr:@fedify/botkit
 ~~~~
 
@@ -57,14 +28,34 @@ to turn it on in your *deno.json* settings:
 ~~~~ json [deno.json] {5}
 {
   "imports": {
-    "@fedify/botkit": "jsr:@fedify/botkit@0.2.0"
+    "@fedify/botkit": "jsr:@fedify/botkit@0.3.0"
   },
   "unstable": ["temporal"]
 }
 ~~~~
 
 [Temporal]: https://tc39.es/proposal-temporal/docs/
 
+### Node.js
+
+You can install BotKit from npm:
+
+::: code-group
+
+~~~~ bash [npm]
+npm add @fedify/botkit
+~~~~
+
+~~~~ bash [pnpm]
+pnpm add @fedify/botkit
+~~~~
+
+~~~~ bash [Yarn]
+yarn add @fedify/botkit
+~~~~
+
+:::
+
 
 Creating a bot
 --------------
@@ -148,9 +139,14 @@ bot.onFollow = async (session, follower) => {
 Running the bot
 ---------------
 
-To run the bot, you need to first connect the bot to the HTTP server.  We will
-utilize [`deno serve`] command.  In order to connect the bot to Deno's HTTP
-server, you need to `export` the `bot` instance as a default export in
+To run the bot, you need to first connect the bot to the HTTP server.  There
+are different ways to run the bot depending on the environment you are
+using.  Here, we will show you how to run the bot in Deno and Node.js.
+
+### Deno
+
+We will utilize [`deno serve`] command.  In order to connect the bot to Deno's
+HTTP server, you need to `export` the `bot` instance as a default export in
 the *bot.ts* file:
 
 ~~~~ typescript [bot.ts]
@@ -173,6 +169,61 @@ And your bot will be available at <http://localhost:8000/>.
 
 [`deno serve`]: https://docs.deno.com/runtime/reference/cli/serve/
 
+### Node.js
+
+In Node.js, we will use the [srvx] package to run the bot.  First, you need to
+install the *srvx* package:
+
+::: code-group
+
+~~~~ bash [npm]
+npm add srvx
+~~~~
+
+~~~~ bash [pnpm]
+pnpm add srvx
+~~~~
+
+~~~~ bash [Yarn]
+yarn add srvx
+~~~~
+
+:::
+
+Then, import [`serve()`] function from `srvx` module:
+
+~~~~ typescript [bot.ts]
+import { serve } from "srvx";
+~~~~
+
+Finally, you can run the bot using the [`serve()`] function at the end of
+the *bot.ts* file:
+
+~~~~ typescript [bot.ts]
+const server = serve({
+  ...bot,
+  port: 8000,
+});
+await server.ready();
+console.log(`Bot is running at ${server.url}`);
+~~~~
+
+Then, you can run the bot using the following command:
+
+~~~~ bash
+node --experimental-transform-types ./bot.ts
+~~~~
+
+The above command will start the bot and it will be available at
+<http://localhost:8000/>:
+
+~~~~
+Bot is running at http://localhost:8000/
+~~~~
+
+[srvx]: https://srvx.h3.dev/
+[`serve()`]: https://srvx.h3.dev/guide/server
+
 
 Exposing the bot to the public internet
 ---------------------------------------