Skip to content

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:

bash
curl -fsSL https://bun.sh/install | bash
bash
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.

bash
bun create elysia app

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

bash
cd app

Start a development server by:

bash
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:

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

Contributors

The avatar of contributor named as saltyaom saltyaom
The avatar of contributor named as Sanghee Park Sanghee Park
The avatar of contributor named as Christian Meredith Christian Meredith
The avatar of contributor named as Patrick Rauls Patrick Rauls
The avatar of contributor named as Anthony Morris Anthony Morris
The avatar of contributor named as Phúc Khang Phúc Khang
The avatar of contributor named as iraqian dev iraqian dev
The avatar of contributor named as Kravets KravetsThe avatar of contributor named as Sam Itani Sam ItaniThe avatar of contributor named as James Robert Lund III James Robert Lund III
The avatar of contributor named as Supachai Kheawjuy Supachai Kheawjuy
The avatar of contributor named as Rawand Rebwar Rawand RebwarThe avatar of contributor named as Dowen Robinson Dowen RobinsonThe avatar of contributor named as Niklas Wojtkowiak Niklas Wojtkowiak
The avatar of contributor named as Jake Boone Jake Boone
The avatar of contributor named as Wazbat Wazbat
The avatar of contributor named as scarf scarf

Changelog