Getting started

This guide walks you through installing one or more @basmilius/* packages into a fresh Vue 3 + Vite project.

Prerequisites

• Node.js >= 23 or Bun >= 1.3.11.
• A Vue 3.6+ project, ideally scaffolded with bun create vite.
• TypeScript with experimentalDecorators enabled if you plan to use @basmilius/http-client.

Install your first package

Most consumers start with @basmilius/utils — it has no peer dependencies and works in any TypeScript project.

Bun

bun add @basmilius/utils

npm

npm install @basmilius/utils

pnpm

pnpm add @basmilius/utils

yarn

yarn add @basmilius/utils

import { formatDate, hexToRGB } from '@basmilius/utils';
import { DateTime } from 'luxon';

formatDate(DateTime.now()); // localised date string
hexToRGB('#0070f3');         // { r: 0, g: 112, b: 243 }

Common stack

For a Vue 3 SPA that also talks to an HTTP API, the typical install is:

Bun

bun add @basmilius/common @basmilius/http-client @basmilius/routing @basmilius/utils

npm

npm install @basmilius/common @basmilius/http-client @basmilius/routing @basmilius/utils

You'll also want the peers:

bun add vue vue-router pinia luxon

TypeScript configuration

Several packages — most notably @basmilius/http-client — rely on stage-2 decorators. Make sure your tsconfig.json opts in:

{
    "compilerOptions": {
        "target": "esnext",
        "module": "esnext",
        "moduleResolution": "bundler",
        "strict": true,
        "experimentalDecorators": true,
        "useDefineForClassFields": true,
        "isolatedDeclarations": true
    }
}

isolatedDeclarations is recommended but optional — it produces faster .d.ts emit when paired with @basmilius/tools.

Next steps

• Read each package's Introduction page (in the sidebar) for a high-level overview.
• Try the HTTP client quick start.
• See Modal routing for a richer UX pattern.