Skip to content

Getting Started

Fang JS está diseñado para ser productivo desde el primer segundo. Aunque puedes usarlo en proyectos vanilla de JavaScript, recomendamos encarecidamente el uso de TypeScript para aprovechar el IntelliSense avanzado y la validación de tipos en los decoradores y el contexto.

Instala el núcleo de Fang JS y su única dependencia de validación (Zod) mediante npm:

Terminal window
npm install @fang-js/fang

Aquí tienes cómo levantar una API funcional en cuestión de segundos.

index.ts
import { Fang } from '@fang-js/fang';
const app = new Fang();
app.get("/", (ctx) => {
ctx.json({ message: "Fang JS ruge con TypeScript! 🐺" });
});
app.listen(3000, () => {
console.log("Server running on http://localhost:3000");
});

Para proyectos que escalan, Fang JS brilla más cuando organizas tu código por capas. Una estructura ideal se vería así:

  1. Controladores: Define tus rutas y lógica de entrada.
  2. Servicios: Maneja la lógica de negocio y base de datos (como Prisma).
  3. Schemas: Define tus validaciones de datos con Zod.
my-api/
├── src/
│ ├── module-name/
│ │ ├── controller.ts
│ │ ├── service.ts
│ │ └── schema.ts
│ └── index.ts # Punto de entrada
├── package.json
└── tsconfig.json