Reference

Manual Setup

The fallback setup flow — clone the template and wire up Supabase by hand, without the CLI.

The primary way to set up VueStarter is the create-vue-starter CLI — it does everything automatically in about 90 seconds. This page is the fallback: every step done manually through the terminal and the Supabase dashboard.

Use this if the CLI fails for you, if you're behind a firewall that blocks the GitHub device flow, or if you just prefer to understand every step.

Extra Prerequisites

The CLI path only needs Node.js. The manual path also needs Git and the GitHub CLI (gh) installed.

macOS

  1. Install the Xcode Command Line Tools (provides Git):
    xcode-select --install
    
  2. Download and run the GitHub CLI installer (.pkg)

Windows

winget install Git.Git
winget install GitHub.cli

Linux (Debian/Ubuntu)

sudo apt update && sudo apt install -y git gh

Close and reopen your terminal after installing so the new commands land on your PATH.

Setup

Accept the GitHub Invite

The VueStarter repository is private. After purchase, you're added as a collaborator — check your email (including spam) for the invite and accept it. You can also visit github.com/Loqode/vue-starter directly; if an invite is pending, GitHub will show a banner letting you accept it there.

Authenticate with GitHub

Because the repo is private, Git needs to know who you are before it will let you clone.

gh auth login

Answer the prompts:

  1. GitHub.com
  2. HTTPS
  3. Yes — when asked "Authenticate Git with your GitHub credentials?"
  4. Login with a web browser — press Enter, copy the one-time code, and complete the flow in your browser

Step 3 is the important one — it tells Git to use your gh login whenever it needs to authenticate. Without it, the clone in the next step can still fail with an authentication error.

Clone the Template

First, navigate to the folder where you keep your projects. If you don't have one yet, create one:

cd ~
mkdir -p apps
cd apps

Then paste this block into your terminal. Replace my-app with whatever you want the project folder to be called.

git clone https://github.com/Loqode/vue-starter.git my-app
cd my-app
git remote remove origin
npm install

Create a Supabase Project

Go to supabase.com and create a new project.

Fill in:

  • Name — anything you like
  • Database password — strong and stored safely
  • Region — pick the one closest to you for lower latency
  • Row Level Security — enable the "automatic" option so RLS is on by default for new tables

It can take a minute or two for the project to finish spinning up — wait until the dashboard shows it as ready before continuing.

Write Your .env File

Copy the example env file, then fill it in:

cp .env.example .env
The command shows no output when it works — that's normal. If you don't see an error, it succeeded.

Open .env in a code editor (VS Code, Cursor, Sublime). If you don't have one installed, open it from the terminal:

  • macOSopen -e .env (opens TextEdit)
  • Windowsnotepad .env
  • Linuxxdg-open .env or nano .env

Grab your credentials from the Supabase dashboard:

  • Project URL — copy from the project dashboard (starts with https://)
  • Publishable key — go to Project Settings → API Keys and copy the publishable key
  • Secret key — on the same page, copy the secret key (click to reveal)

Paste them into .env:

SUPABASE_URL=https://your-project.supabase.co
SUPABASE_KEY=your-publishable-key
SUPABASE_SECRET_KEY=your-secret-key

Save the file once all three values are filled in (Cmd + S on macOS, Ctrl + S on Windows/Linux).

Optional — OPENROUTER_API_KEY enables the baked-in AI Assistant. Get a key at openrouter.ai and paste it into .env. Leave blank to hide the chat UI — everything else still works. See AI Chat reference for details.

Apply the Initial Migration

The template has a database migration that needs to run against your fresh Supabase project:

  1. Open supabase/migrations/00001_initial_schema.sql in your code editor and copy the whole file
  2. In the Supabase dashboard, go to SQL Editor → New query
  3. Paste the SQL and click Run
  4. Confirm it succeeded (no red errors at the bottom)

Disable Email Confirmation (Development)

Supabase's default email provider has a limit of 2 confirmation emails per hour, which will slow you down during development. Turn it off for now:

  1. Go to Authentication → Sign In / Providers in your Supabase dashboard
  2. Scroll to the User Signups section
  3. Toggle Confirm email off
  4. Click Save

You can re-enable this once you've set up a custom SMTP provider, or before going to production.

Start the Dev Server

npm run dev

Open http://localhost:3000. You should see the login page.

Verify Everything Works

  1. Click Sign up and create an account
  2. You should be logged in immediately (email confirmation is off)
  3. Complete the onboarding — enter a team name and your display name
  4. You should land on the dashboard
  5. Check the sidebar shows Dashboard and Settings
  6. Go to Settings → Members and verify you're listed as the owner

Next Steps