Installation

Avleon requires Node.js 20 or newer.

Using Cli

If you already installed @avleon/cli globally then run the following command:

avleon new myapi

else you can install using npx:

npx @avleon/cli new myapi

pnpm dlx @avleon/cli new myapi

yarn dlx @avleon/cli new myapi

The CLI asks which package manager to use and which features to include — OpenAPI docs, CORS, TypeORM, Knex and Scalar UI — then scaffolds the project and installs its dependencies.

cd myapi
npm run start:dev

The app starts on http://localhost:4000, and with OpenAPI enabled the docs are served at /docs.

What you get

myapi/
├── src/
│   ├── controllers/     # Route controllers
│   ├── services/        # Business logic
│   ├── config/          # App configuration
│   ├── app.ts           # App setup
│   └── serve.ts         # Entry point
├── test/
├── tsconfig.json
└── package.json

Manual

Go to your desired project directory and run the following commands:

mkdir myapi && cd myapi &&  mkdir src

New-Item -ItemType Directory -Name myapi
Set-Location myapi
New-Item -ItemType Directory -Name src

npm init -y
npm i @avleon/core
npm i --save-dev typescript @types/node
npx tsc --init

pnpm init
pnpm i @avleon/core
pnpm i --save-dev typescript @types/node
pnpm tsc --init

yarn init -y
yarn add @avleon/core
yarn add --dev typescript @types/node
yarn tsc --init

class-validator, class-transformer and reflect-metadata come with @avleon/core, so you do not need to install them separately.

Ensure experimentalDecorators and emitDecoratorMetadata are enabled in tsconfig.json — Avleon's decorators do not work without them.

    // "jsx": "preserve",  
    "experimentalDecorators": true,               
    "emitDecoratorMetadata": true,               
    // "jsxFactory": "",

Then add a minimal entry point:

import { Avleon } from '@avleon/core';

const app = Avleon.createApplication();

app.mapGet('/', () => 'Welcome to Avleon.');

app.run();

You can still use the CLI's generators and dev server in a manually created project by installing it locally:

npm i -D @avleon/cli
npx avleon serve

Optional dependencies

Install these only for the features you use: