Contributing

Contributions to VitNode - whether bug fixes, new features, or documentation improvements - are always welcome!

Quick start

Clone the repository, start local containers, and launch the dev server:

Setup VitNode monorepo

bun install
bun run docker:dev
bun dev

pnpm install
pnpm docker:dev
pnpm dev

npm install
npm run docker:dev
npm run dev

Open http://localhost:3000 to view the website, AdminCP, and live docs.

Directory	Role
`packages/vitnode`	`@vitnode/core` package containing routing, auth, models, and UI primitives
`apps/web`	Frontend TanStack Start application and documentation portal
`apps/api`	Standalone Hono REST/RPC API server
`plugins/*`	First-party plugins (`@vitnode/blog`, `@vitnode/example`)

Before opening a pull request, run the same checks that execute in GitHub Actions CI:

Typecheck

bun run typecheck

pnpm typecheck

npm run typecheck

Run unit tests

bun test

pnpm test

npm test

Build workspaces

bun run build

pnpm build

npm run build

Focused PRs: Keep changes scoped to a single feature or bug fix.
Follow Conventions: Follow repository conventions from AGENTS.md (no any, arrow function components, semantic tokens).
Tests: Add unit tests for non-trivial logic using Vitest.