Quickstart
Deploy a project from a GitHub repo. You'll have a live URL in about five minutes.
Before you start
You'll need:
- A Velumi account — free, no credit card
- A GitHub repository with a Next.js or Nuxt project
- A few minutes
No repo handy? You can also deploy by uploading a
.zip archive. See Source types for the full list.1. Create a project
From the dashboard, click Create project. The wizard walks you through:
- Project — name your project (it's placed in your personal organization automatically)
- Environment — select your framework (Next.js or Nuxt)
- Source — pick your GitHub repo and branch (you can connect GitHub here if you haven't yet)
- Plan & Billing — start on Dev (free, 10 GB bandwidth) or pick a paid plan
- Review — confirm and create
The free Dev plan is for staging, testing, and public previews of work in progress. It has no credit card requirement and includes 10 GB of bandwidth per month. Bandwidth overages on Dev are rate-limited, not charged.
Your project lives in a personal organization Velumi created for you automatically. You can create additional organizations at any time — useful for separating client projects or teams.
2. Wait for the first build
Velumi pulls your repo, builds it, and deploys to the region you picked. You'll see live build logs while it runs.
Build statuses: Pending → Building → Built → Deploying → Ready.
When you reach Ready, the project is live at the default *.velumi.dev URL shown on the project's Overview tab.
3. Add a custom domain (optional)
On the project, open the Domains tab and add your domain. Velumi gives you the DNS records to point at it (typically a CNAME or A record). SSL is issued automatically once DNS resolves.
See Add a custom domain.
What's next
- Core concepts — the mental model: organization → project → environment → deployment
- Organizations — create more orgs for teams or clients
- Environment variables — runtime vs build-time,
NEXT_PUBLIC_*,VITE_* - Plans — when to upgrade from Dev