AzuraJS Logo
AzuraJSFramework
v2.2 Beta

Instalação

Instale AzuraJS no seu projeto

Instalação 📦

Comece com AzuraJS instalando-o no seu projeto Node.js ou Bun.

Pré-requisitos ✅

Antes de instalar AzuraJS, certifique-se de ter:

  • Node.js 18+ ou Bun 1.0+
  • TypeScript 5.0+ (recomendado)
  • Um gerenciador de pacotes: npm, yarn, pnpm ou bun

Métodos de Instalação

Usando npm

npm install azurajs

Usando Yarn

yarn add azurajs

Usando pnpm

pnpm add azurajs

Usando Bun

bun add azurajs

Configuração TypeScript 🔧

AzuraJS requer que decorators experimentais sejam habilitados. Atualize seu tsconfig.json:

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

Opções de Configuração Importantes

experimentalDecorators: Habilita suporte a decorators TypeScript (necessário para @Controller, @Get, etc.)

emitDecoratorMetadata: Habilita reflexão de metadados (recomendado para recursos avançados)

Configuração do Projeto 🏗️

Crie uma nova estrutura de projeto:

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

Crie os arquivos básicos:

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

Verificar Instalação ✔️

Crie um arquivo de teste simples para verificar se tudo está funcionando:

src/index.ts
import { AzuraClient } from "azurajs";

const app = new AzuraClient();
console.log("✅ AzuraJS instalado com sucesso!");

Execute:

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

# Com Bun
bun run src/index.ts

Se você ver a mensagem de sucesso, está pronto para começar! 🎉

Dependências de Desenvolvimento (Opcional) 📚

Para uma melhor experiência de desenvolvimento, considere instalar:

# TypeScript e definições de tipos
npm install -D typescript @types/node

# Servidor de desenvolvimento com hot reload
npm install -D tsx nodemon

# ou use o modo watch integrado do Bun
bun --watch src/index.ts

Próximos Passos 🚀

Agora que AzuraJS está instalado, você está pronto para:

Solução de Problemas 🔍

Erros de Decorator

Se você receber erros sobre decorators não sendo reconhecidos:

  1. Certifique-se de que experimentalDecorators está habilitado no tsconfig.json
  2. Verifique se está usando TypeScript 5.0 ou superior
  3. Confirme que seu editor está usando a versão TypeScript do workspace

Erros de Importação

Se você não consegue importar de azurajs:

  1. Verifique se o pacote está instalado: npm list azurajs
  2. Tente deletar node_modules e reinstalar
  3. Limpe o cache do TypeScript: rm -rf .tsbuildinfo

Erros de Tipo

Para problemas relacionados a tipos:

  1. Certifique-se de que @types/node está instalado
  2. Defina "moduleResolution": "bundler" ou "node16" no tsconfig
  3. Habilite esModuleInterop e skipLibCheck

Precisa de ajuda? Confira nossas Issues no GitHub ou inicie uma Discussão!

On this page