Quick Start

Get your Velocity project running in just a few commands.

Using the CLI (Recommended)

The fastest way to start is with the official CLI:

pnpm create velocity-astro my-project
cd my-project
pnpm dev

npm create velocity-astro@latest my-project
cd my-project
npm run dev

yarn create velocity-astro my-project
cd my-project
yarn dev

bun create velocity-astro my-project
cd my-project
bun run dev

Alternatively, clone the repository directly:

git clone https://github.com/southwellmedia-dev/velocity.git my-project
cd my-project
pnpm install

git clone https://github.com/southwellmedia-dev/velocity.git my-project
cd my-project
npm install

git clone https://github.com/southwellmedia-dev/velocity.git my-project
cd my-project
yarn install

cp .env.example .env

Edit .env and set your production domain:

SITE_URL=https://yoursite.com

pnpm dev

Your site is now available at http://localhost:4321.

Set your domain in .env → SITE_URL=https://yoursite.com
Update site info in src/config/site.config.ts → name, description, author, contact
Configure navigation in src/config/routes.ts → add/remove pages from nav
Replace branding in src/assets/branding/ → your logo SVGs
Update favicon in public/favicon.svg → your icon