GoatDB Installation
GoatDB can be installed in both Deno and Node.js environments. Deno is our preferred runtime (with benefits like compiling to a self-contained executable), while Node.js support is currently experimental.
Deno Installation (Recommended)
-
Add GoatDB to your project:
deno add jsr:@goatdb/goatdb
-
Initialize the React Scaffold (optional, for SPAs only):
deno run -A jsr:@goatdb/goatdb/init
Note: The initialization step is only required for Single Page Applications (SPAs). This command installs React dependencies and creates a project scaffold with both client-side and server-side code structures. Skip this step if you’re not building a SPA or already have your React setup configured.
Node.js Installation
Install using one of the following package managers:
Node.js support is currently a work in progress and is not yet ready for production. Progress is tracked under this GitHub issue.
npm:
npx jsr add @goatdb/goatdb
Yarn:
yarn dlx jsr add @goatdb/goatdb
pnpm:
pnpm dlx jsr add @goatdb/goatdb