Getting Started

Prerequisites

Before you start the initial setup, you need to have 2 runtimes installed:

• NodeJS version 20 or higher
• Bun version 1.1.3 or higher

Although Bun is the primary runtime, one of the dependencies (Prisma) still requires Node to generate the initial files.

Tip

If you already have Node installed, you can install bun via npm:

npm install -g bun@1.1.3

Configuration

You can either fork this project or clone it, the choice is yours.

Now, the first step is to install the project dependencies:

bun install

Running the Server

The project is set up as a monorepo (or workspace) using a tool called turbo repo.

This means that to run the server from the project root, you need to run:

bun run dev --filter=taco-api

Running the Server with Docker

If you want a fully configured environment, it’s also possible to run the project via Docker.

For this, at the project root, run the command:

docker-compose -f ./apps/api/docker-compose.yml up

Note

The docker-compose is configured to run the API in development mode. To deploy as a docker image, visit the section Deploy > Docker

Running the Documentation

If you want to edit the documentation, in the project’s root directory, run the command:

bun run dev --filter=website