Skip to main content

Installation

BurgerAPI is built for the Bun.js runtime. Make sure you have Bun installed before you begin.

Prerequisites

  • Bun: Follow the official Bun installation guide to install it on your system.

    You can verify your installation by running:

    bun --version

Setting up Your Project

  1. Initialize a new Bun project:

    Navigate to the directory where you want to create your project and run:

    bun init

    Follow the prompts. Choosing the defaults for a blank project is usually sufficient to start.

  2. Install BurgerAPI:

    Add the burger-api package to your project's dependencies:

    bun add burger-api
    Coming Soon!

    We plan to introduce a dedicated BurgerAPI CLI tool in the future to streamline project creation and management. For now, please use the standard Bun commands outlined below.

Ready to Go!

That's it! You now have a Bun project set up with BurgerAPI installed.

Next, you might want to check out the Configuration guide to see how to create your first BurgerAPI instance.