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.
Install all required project dependencies:
npm install
Create your local environment file:
cp .env.example .env
At minimum, configure the following environment variables:
NUXT_SESSION_PASSWORD=32-character-secret
NUXT_PUBLIC_CDN_URL=get from supabase
NUXT_SUPABASE_SERVICE_ROLE_KEY=get from supabase
NUXT_SUPABASE_STORAGE_BUCKET=get from supabase
NUXT_SUPABASE_URL=get from supabase
RESEND_API_KEY=get from resend.com
Additional environment variables are only required when using optional integrations such as OAuth providers.
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
If your project includes seed data, execute the seed script as well.
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.