Installation 📦

Get started with AzuraJS by installing it in your Node.js or Bun project.

Prerequisites ✅

Before installing AzuraJS, make sure you have:

Node.js 18+ or Bun 1.0+
TypeScript 5.0+ (recommended)
A package manager: npm, yarn, pnpm, or bun

Installation Methods

Using npm

npm install azurajs

Using Yarn

yarn add azurajs

Using pnpm

pnpm add azurajs

Using Bun

bun add azurajs

TypeScript Configuration 🔧

AzuraJS requires experimental decorators to be enabled. Update your tsconfig.json:

tsconfig.json

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  }
}

Key Configuration Options

experimentalDecorators: Enables TypeScript decorators support (required for @Controller, @Get, etc.)

emitDecoratorMetadata: Enables metadata reflection (recommended for advanced features)

Project Setup 🏗️

Create a new project structure:

mkdir my-azura-app
cd my-azura-app
npm init -y
npm install azurajs

Create basic files:

my-azura-app/
├── src/
│   ├── index.ts
│   └── controllers/
│       └── AppController.ts
├── azura.config.ts
├── tsconfig.json
└── package.json

Verify Installation ✔️

Create a simple test file to verify everything is working:

src/index.ts

import { AzuraClient } from "azurajs";

const app = new AzuraClient();
console.log("✅ AzuraJS installed successfully!");

Run it:

# With Node.js
npx tsx src/index.ts

# With Bun
bun run src/index.ts

If you see the success message, you're ready to go! 🎉

Development Dependencies (Optional) 📚

For a better development experience, consider installing:

# TypeScript and type definitions
npm install -D typescript @types/node

# Development server with hot reload
npm install -D tsx nodemon

# or use Bun's built-in watch mode
bun --watch src/index.ts