🐥 Helix Server

A lightweight and high-performance fully extensible and minimalist web server framework for Bun.js.

Table of Contents

• Getting Started
• Installation
• Create Your First Server
• Run Your Server
• For More Examples
• Documentation
• Contributing

Getting Started

This guide will help you create your first Helix server application.

Prerequisites

• Bun installed on your system

Installation

First, install the Helix server package:

bun add @helix-server/core

Create Your First Server

Create a new file called index.ts:

touch index.ts

Add the following code to index.ts:

import helix from '@helix-server/core';

helix.get({
	route: '/',
	async handler(ctx) {
		ctx.res.setBody('hello world');
	},
});

helix.run(3000, '127.0.0.1');

Run Your Server

Start the server with:

bun run index.ts

You should see the message:

Server running at http://127.0.0.1:3000

Visit http://127.0.0.1:3000 in your browser to see "hello world".

For More Examples

Check out the examples repository for more sample applications.

Documentation

For detailed documentation, visit the Helix Server Documentation.

Contributing

Contributions are welcome! Please read the contributing guidelines to get started.