Getting Started

Nixle is a framework for building HTTP servers. It is designed to be simple, fast, and extensible. It is built on top of existing frameworks, such as Express, Fastify, and Nuxt.

Installation

You can install the nixle package using npm, pnpm, yarn, or bun:

npm

npm i nixle

pnpm

pnpm add nixle

yarn

yarn add nixle

bun

bun i nixle

Quick Start

Compatibility Note

Nixle requires Node.js version 18+. 20+.

Create base

Before you can create a server, you need to create a base. A base is a collection routes that form the foundation of your server. Once you have created a base, you can proceed to create services or explore other topics in the Overview section.

// usersRouter.ts
import { createRouter } from 'nixle';

export const usersRouter = createRouter('/users', ({ route }) => [
  route.get('/', () => 'Hello World!'),
]);

Choose a provider

Each provider provides the same functionality, but with different frameworks. You can choose from the following providers:

Nuxt

import { createApp } from 'nixle';
import { nitroProvider } from '@nixle/nitro';
import { usersRouter } from './usersRouter';

export default defineNitroPlugin((nitroApp) => {
  createApp({
    provider: nitroProvider(nitroApp),
    routers: [usersRouter],
  });
});

Express

import express from 'express';
import { createApp } from 'nixle';
import { expressProvider } from '@nixle/express';
import { usersRouter } from './usersRouter';

const { app } = createApp({
  provider: expressProvider(express()),
  routers: [usersRouter],
});

app.listen(3000);

Fastify

import fastify from 'fastify';
import { createApp } from 'nixle';
import { fastifyProvider } from '@nixle/fastify';
import { usersRouter } from './usersRouter';

const { app } = createApp({
  provider: fastifyProvider(app),
  routers: [usersRouter],
});

app.listen({ port: 3000 });

Elysia

import { Elysia } from 'elysia';
import { createApp } from 'nixle';
import { elysiaProvider } from '@nixle/elysia';
import { usersRouter } from './usersRouter';

const { app } = createApp({
  provider: honoProvider(new Elysia()),
  routers: [usersRouter],
});

app.listen(3000);

Hono

import { Hono } from 'hono';
import { serve } from '@hono/node-server';
import { createApp } from 'nixle';
import { honoProvider } from '@nixle/hono';
import { usersRouter } from './usersRouter';

const { app } = createApp({
  provider: honoProvider(app),
  routers: [usersRouter],
});

serve(app, (info) => {
  console.log(`Listening on http://localhost:${info.port}`);
});

Or create your own provider.

Try it

After successfully creating the server, you can try it out to send a request to the server.

const data = fetch('http://localhost:3000/users').then((res) => res.text());

console.log(data); // Hello World!

Next Steps

Take a look at the Overview section to learn more about available features. To create clean and maintainable code you can use our services, which are described in the Services section. Also we have logger and plugins.