Getting Started 🎉

Are you eager to start a TypeScript-based web project? Abi is the perfect solution to serve your resources, web services or applications in no time and without any hassle!

Work in progress

Abi is in early development. If you find something that’s not working, open an issue on the GitHub repository.

📋 Requirements

Currently, Abi only works under:

Node.js, Deno, Bun, Cloudflare Workers

⚡️ Installation

You can install Abi from NPM or JSR:

npm

From NPM:

npm install abi.js@latest

From JSR:

npx jsr add @abi-js/abi

Yarn

From NPM:

yarn add abi.js

From JSR:

yarn dlx jsr add @abi-js/abi

pnpm

From NPM:

pnpm add abi.js

From JSR:

pnpm dlx jsr add @abi-js/abi

Bun

From NPM:

bun install abi.js

From JSR:

bunx jsr add @abi-js/abi

Deno

From NPM:

deno install npm:abi.js

From JSR:

deno add @abi-js/abi

🧑‍💻 Usage

Use Abi with your server runtime:

NPM

import { Abi } from "abi.js";

const abi = new Abi();

abi.get('', 'Welcome to Abi.js!');
abi.get(':name', (name: string) => `Hello ${name}!`);

export default abi;

JSR

import { Abi } from "@abi-js/abi";

const abi = new Abi();

abi.get('', 'Welcome to Abi.js!');
abi.get(':name', (name: string) => `Hello ${name}!`);

export default abi;