Installation
Get started with Carabao.js in seconds. No build tools, no complex setup.
Quick Start
Scaffold a new project immediately without installing anything globally:
npx carabao create my-app
cd my-app
npm install
npm run build
npm start
cd my-app
npm install
npm run build
npm start
Your server will be running at http://localhost:9000.
Global Installation
Install the CLI globally for repeated use:
# npm
npm install -g carabao
# or yarn
yarn global add carabao
# or pnpm
pnpm add -g carabao
npm install -g carabao
# or yarn
yarn global add carabao
# or pnpm
pnpm add -g carabao
Then scaffold projects with:
carabao create my-app
Using as a Library
Add Carabao.js to an existing project:
# npm
npm install carabao
# or yarn
yarn add carabao
# or pnpm
pnpm add carabao
npm install carabao
# or yarn
yarn add carabao
# or pnpm
pnpm add carabao
Requirements
- Node.js >= 18 (LTS recommended)
- npm, yarn, or pnpm
- TypeScript knowledge recommended but not required