Quick Start

This guide will walk you through building a complete full-featured application with Velist. Choose your path: let AI agents build 99% of it, or code it yourself to learn the internals.

Prerequisites

• Bun >= 1.0.0 installed
• Basic knowledge of TypeScript and Svelte

Create a New Project

One command creates everything — the installer handles cloning, dependencies, database setup, and environment configuration.

# Create project (interactive mode)
bun create velist my-app

The CLI will ask you:

• Install dependencies? (default: yes) — runs bun install
• Setup database? (default: yes) — runs migrations and seeds

Then simply:

cd my-app
bun run dev

Your app is now running at:

• Application: http://localhost:3000
• Vite Dev Server: http://localhost:5173

Default login: [email protected] / password123

What the installer does for you

• ✅ Clones the starter template
• ✅ Initializes git repository
• ✅ Generates secure JWT secret in .env
• ✅ Updates package.json with your project name
• ✅ Installs dependencies (if selected)
• ✅ Runs database migrations & seeds (if selected)

---

Build Your Application

Now let's build a complete Task Management Application. Choose your path: