Quick Start

Elysia is a TypeScript backend framework with multiple runtime support but optimized for Bun.

However, you can use Elysia with other runtimes like Node.js.

Bun

Elysia is optimized for Bun which is a JavaScript runtime that aims to be a drop-in replacement for Node.js.

You can install Bun with the command below:

MacOS/Linux

curl -fsSL https://bun.sh/install | bash

Windows

powershell -c "irm bun.sh/install.ps1 | iex"

Auto Installation

We recommend starting a new Elysia server using bun create elysia, which sets up everything automatically.

bun create elysia app

Once done, you should see the folder name app in your directory.

cd app

Start a development server by:

bun dev

Navigate to localhost:3000 should greet you with "Hello Elysia".

TIP

Elysia ships you with dev command to automatically reload your server on file change.

Next Steps

We recommend checking out the either one of the following:

Key Concept (5 minutes)

The core concept of Elysia and how to use it.

Tutorial (15 minutes)

A step-by-step guide walkthrough Elysia's features.

If you have any questions, feel free to ask in our Discord community.