Velocity
/Documentation
GitHub
Getting Started

Quickstart Guide

Get up and running with Velocity in under 5 minutes. This guide will walk you through creating your first project and deploying it to production.

On this page

Prerequisites

Before you begin, make sure you have the following installed on your machine:

  • Node.js 18.0 or later
  • npm, yarn, or pnpm package manager
  • A Velocity account (sign up for free)
  • Git installed and configured

Install the CLI

The Velocity CLI is the fastest way to interact with our platform. Install it globally using npm:

bash
npm install -g @velocity/cli

Then authenticate with your Velocity account:

bash
velocity login

Create a project

Create a new project using our starter template:

bash
# Create a new Next.js project
velocity create my-app --template nextjs

# Navigate to your project
cd my-app

# Start the development server
npm run dev

Pro tip

You can also import an existing Git repository using velocity import

Deploy to production

When you're ready to deploy, simply run:

bash
velocity deploy

That's it! Your app will be built and deployed to our global edge network. You'll receive a unique URL where your app is live.

output
✓ Building project...
✓ Optimizing assets...
✓ Deploying to edge network...

🚀 Deployed to: https://my-app-abc123.velocity.app

Production URL: https://my-app.velocity.app

Next steps

Now that you have your first project deployed, here are some things you can explore:

Custom Domains

Connect your own domain to your project

Environment Variables

Configure secrets and environment variables

Team Collaboration

Invite team members to your project

AI Code Generation

Use AI to accelerate your development

Was this page helpful?

Let us know how we can improve