This guide walks you through setting up Vuesion for local development.
Before you begin, make sure the following tools are installed:
Vuesion uses PostgreSQL as its database. The recommended development setup runs PostgreSQL through Docker, so a separate PostgreSQL installation is not required.
Extract the downloaded Vuesion archive to a location of your choice and open the project in your preferred IDE.
Create your local environment file:
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:
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.
Install all required project dependencies:
npm install
Start the local PostgreSQL container:
docker compose up -d
Verify that the database container is running:
docker compose ps
Run the database migrations:
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.
npm run db:seed
Launch the application:
npm run dev
Once the development server has started, open the application in your browser:
http://localhost:3000
When you are finished developing, stop the PostgreSQL container:
docker compose down
The database data remains available because it is stored in a persistent Docker volume.
Continue with First Run to verify your installation and get familiar with the project structure.