---
title: Installation
description: Installation guide for our application.
date: 17-02-2025
---

Setting up DocuBook is straightforward, with options to clone the repository or use the convenient `npx` command. DocuBook requires [Node.js](https://nodejs.org/) version 18 or higher for optimal performance.

## Clone Repository

To get started, you can clone the DocuBook repository directly from GitHub.

<Stepper>
  <StepperItem title="Step 1: Clone the DocuBook Repository">
    Begin by cloning the DocuBook repository from GitHub:

    ```bash
    git clone --branch starter https://gitlab.com/mywildancloud/docubook.git
    ```

  </StepperItem>

  <StepperItem title="Step 2: Access the Project Directory">
    After cloning, navigate into the project directory to start setting up:

    ```bash
    cd docubook
    ```

  </StepperItem>

  <StepperItem title="Step 3: Install Required Dependencies">
    Install all necessary project dependencies with npm:

    ```bash
    npm install
    ```

  </StepperItem>

  <StepperItem title="Step 4: Launch the Development Server">
    Finally, start the development server to view the project locally:

    ```bash
    npm run dev
    ```

  </StepperItem>
</Stepper>

## Quick Setup with CLI

For a faster setup, use the `cli` command to create a new DocuBook project in one step:

<Tabs defaultValue="npm" className="pt-5 pb-1">
  <TabsList>
    <TabsTrigger value="npm">npm</TabsTrigger>
    <TabsTrigger value="pnpm">pnpm</TabsTrigger>
    <TabsTrigger value="bun">bun</TabsTrigger>
    <TabsTrigger value="yarn">yarn</TabsTrigger>
  </TabsList>
  <TabsContent value="npm">
    ```shell
    npx @docubook/create@latest
    ```
  </TabsContent>
  <TabsContent value="pnpm">
    ```shell
    pnpm dlx @docubook/create@latest
    ```
  </TabsContent>
  <TabsContent value="bun">
    ```shell
    bunx @docubook/create@latest
    ```
  </TabsContent>
  <TabsContent value="yarn">
    ```shell
    yarn dlx @docubook/create@latest
    ```
  </TabsContent>
</Tabs>

With this setup, you’ll have a ready-to-use DocuBook instance to start building your documentation.
