---
title: "Installation"
description: "Set up Vuesion for local development."
canonical_url: "https://www.vuesion.dev/docs/getting-started/installation"
---

> Index of every page on this site: [llms.txt](https://www.vuesion.dev/llms.txt)

# Installation

This guide walks you through setting up Vuesion for local development.

## Prerequisites

Before you begin, make sure the following tools are installed:

- Node.js 26 or newer
- npm
- Git
- Docker with Docker Compose

Vuesion uses PostgreSQL as its database. The recommended development setup runs PostgreSQL through Docker, so a separate PostgreSQL installation is not required.

## Extract the project

Extract the downloaded Vuesion archive to a location of your choice and open the project in your preferred IDE.

## Configure the environment

Create your local environment file:

```bash
cp .env-example .env
```

`.env-example` lists every environment variable, split into **MANDATORY** and **OPTIONAL** with a comment per variable. A local setup works with the defaults. Replace at least the session password:

```env
NUXT_SESSION_PASSWORD=32-character-secret
```

Uncomment the optional variables of an integration, such as file storage (Supabase), OAuth providers or billing, when you use it. See [Configuration](https://www.vuesion.dev/docs/development/configuration#required-and-optional-variables).

## Install dependencies

Install all required project dependencies:

```bash
npm install
```

## Start the database

Start the local PostgreSQL container:

```bash
docker compose up -d
```

Verify that the database container is running:

```bash
docker compose ps
```

## Prepare the database

Run the database migrations:

```bash
npm run db:migrate
```

Then run the seed. It synchronizes the Feature Catalog and creates the initial plan, which new workspaces require. Without it, registration fails.

```bash
npm run db:seed
```

## Start the development server

Launch the application:

```bash
npm run dev
```

Once the development server has started, open the application in your browser:

```text
http://localhost:3000
```

## Stop the database

When you are finished developing, stop the PostgreSQL container:

```bash
docker compose down
```

The database data remains available because it is stored in a persistent Docker volume.

## Next steps

Continue with **First Run** to verify your installation and get familiar with the project structure.

## Sitemap

See the full [sitemap](https://www.vuesion.dev/sitemap.md) for all pages.
