# Velocity

> Velocity is a full-stack Go web framework with unified API, driver-based architecture, and zero configuration lock-in. Build faster, ship sooner.

Velocity is a Go web framework. Source: https://github.com/velocitykode/velocity. Full documentation corpus available at https://vel.build/llms-full.txt.

## Getting Started

> Get started with Velocity Go framework. Install the CLI, create your first project, and learn the basics in minutes.

- [Getting Started (overview)](https://vel.build/docs/getting-started/): section landing page.
- [Getting Started](https://vel.build/docs/getting-started/getting-started/): Install Velocity CLI, create your first Go web application, and run the development server with hot reload.

## CLI

> Velocity CLI reference. Create projects, run dev servers, generate code, and manage your Go web application from the command line.

- [CLI (overview)](https://vel.build/docs/cli/): section landing page.
- [Installation](https://vel.build/docs/cli/installation/): Install the Velocity CLI on macOS using Homebrew. Create and manage Go web applications with the velocity command line tool.
- [vel Commands](https://vel.build/docs/cli/commands/): Complete reference for the per-project `vel` CLI - serve, build, migrations, queues, code generation, maintenance, and keys.
- [Configuration](https://vel.build/docs/cli/configuration/): Configure Velocity CLI defaults for database, cache, and queue drivers. Set project scaffolding preferences for faster development.
- [velocity Commands](https://vel.build/docs/cli/installer/): Reference for the global `velocity` installer - scaffold new projects, manage CLI defaults, and keep the installer up to date.

## Core Framework

> Core Velocity features including routing, handlers, middleware, authentication, validation, caching, and logging.

- [Core Framework (overview)](https://vel.build/docs/core/): section landing page.
- [Configuration](https://vel.build/docs/core/config/): Manage application configuration with environment variables and structured config files in Velocity.
- [Authentication](https://vel.build/docs/core/authentication/): Implement user login, registration, password hashing, and session management with Velocity's auth system.
- [Handlers](https://vel.build/docs/core/handlers/): Organize HTTP request handling with Velocity handlers and Context-based handlers.
- [Logging](https://vel.build/docs/core/logging/): Log messages with Velocity's driver-based logging system supporting console, file, and daily rotation.
- [Async](https://vel.build/docs/core/async/): Run concurrent operations with Velocity's Go-idiomatic async wrappers for goroutines and channels.
- [Cache](https://vel.build/docs/core/cache/): Store and retrieve data with Velocity's multi-driver cache system supporting Redis and in-memory storage.
- [Middleware](https://vel.build/docs/core/middleware/): Add middleware for authentication, logging, CORS, rate limiting, and custom request processing in Velocity.
- [Form Requests](https://vel.build/docs/core/form-requests/): Self-validating request types with automatic binding, flashing, and redirect-on-failure.
- [Cryptography](https://vel.build/docs/core/crypto/): Encrypt and decrypt data with AES cipher modes and key rotation in Velocity.
- [Routing](https://vel.build/docs/core/routing/): Define routes in Velocity using the declarative Routing API.
- [Validation](https://vel.build/docs/core/validation/): Validate HTTP requests and form data with Velocity's declarative rule-based validation system.
- [HTTP Router](https://vel.build/docs/core/http-router/): Low-level router reference - Context API, route definition, parameters, JSON binding, and named routes.
- [Resources](https://vel.build/docs/core/resource/): Transform domain models into API responses with collections, pagination, and conditional fields.
- [CSRF Protection](https://vel.build/docs/core/csrf/): Protect your Velocity application against cross-site request forgery attacks with built-in CSRF middleware.
- [String Utilities](https://vel.build/docs/core/string-utilities/): Manipulate strings with Velocity's fluent string utilities for slugs, cases, truncation, and more.
- [Exceptions](https://vel.build/docs/core/exceptions/): Structured error handling with rich dev pages, safe production responses, content negotiation, and pluggable reporters.

## Frontend & Views

> Build modern frontends with Velocity using Inertia.js, React, TypeScript, and Vite for SPA-like experiences.

- [Frontend & Views (overview)](https://vel.build/docs/frontend/): section landing page.
- [Frontend Setup](https://vel.build/docs/frontend/setup/): Set up Velocity's frontend stack with Inertia.js, React, TypeScript, and Vite for hot-reload development.
- [Inertia.js](https://vel.build/docs/frontend/inertia/): Connect Go handlers to React components with Inertia.js for SPA navigation without building an API.
- [View Engine](https://vel.build/docs/frontend/view/): Server-side view engine for Inertia-style rendering with shared props, lazy/deferred props, and optional SSR.
- [React Components](https://vel.build/docs/frontend/components/): Build type-safe React components that receive props directly from Velocity Go handlers.
- [Forms](https://vel.build/docs/frontend/forms/): Handle form submissions with Inertia's useForm hook for validation, error handling, and submission states.

## Database & Models

> Work with databases in Velocity using GORM-based ORM, migrations, query builder, and model relationships.

- [Database & Models (overview)](https://vel.build/docs/database/): section landing page.
- [Getting Started](https://vel.build/docs/database/getting-started/): Connect to PostgreSQL, MySQL, or SQLite and define models with Velocity's hand-rolled, ctx-first ORM.
- [Query Builder](https://vel.build/docs/database/queries/): Build complex database queries with Velocity's fluent query builder for filtering, sorting, and pagination.
- [Relationships](https://vel.build/docs/database/relationships/): Define hasOne, hasMany, belongsTo, manyToMany, and polymorphic relationships with eager loading in Velocity ORM.
- [Global Query Scopes](https://vel.build/docs/database/scopes/): Register named scopes that apply to every query for a model, with per-query opt-out for admin and cross-tenant work.
- [CRUD Operations](https://vel.build/docs/database/crud/): Create, read, update, and delete database records with Velocity ORM's ctx-first API.
- [Transactions](https://vel.build/docs/database/transactions/): ctx-bound transactions, savepoints, and post-commit callbacks for the Velocity ORM.
- [Migrations](https://vel.build/docs/database/migrations/): Version control your database schema with Velocity migrations for creating tables and modifying columns.
- [Transactional Outbox](https://vel.build/docs/database/outbox/): Atomically commit side effects (queue jobs, events) alongside database writes using the outbox pattern, with a built-in relay for delivery, retries, and DLQ.

## Real-time Features

> Build real-time applications with Velocity's WebSockets and broadcasting for live updates and bidirectional communication.

- [Real-time Features (overview)](https://vel.build/docs/realtime/): section landing page.
- [Broadcasting](https://vel.build/docs/realtime/broadcast/): Broadcast events to multiple clients with public, private, and presence channels in Velocity.
- [WebSockets](https://vel.build/docs/realtime/websockets/): Real-time bidirectional communication - typed message handlers, groups, broadcasts, and per-client metadata.

## Advanced Topics

> Advanced Velocity features including queues, email, file storage, task scheduling, and event-driven architecture.

- [Advanced Topics (overview)](https://vel.build/docs/advanced/): section landing page.
- [Storage](https://vel.build/docs/advanced/storage/): Store and retrieve files with Velocity's unified storage interface for local filesystem and Amazon S3.
- [Queue System](https://vel.build/docs/advanced/queue/): Background job processing with Velocity's queue system
- [Mail](https://vel.build/docs/advanced/mail/): Send emails with Velocity's driver-based mail system supporting SMTP, Mailgun, SES, and more.
- [Task Scheduler](https://vel.build/docs/advanced/scheduler/): Schedule recurring tasks with Velocity's fluent scheduler for cron jobs, daily tasks, and periodic work.
- [Notifications](https://vel.build/docs/advanced/notifications/): Send notifications across mail, database, broadcast, and Slack from a single definition.
- [HTTP Client](https://vel.build/docs/advanced/httpclient/): Instrumented outbound HTTP client with APM events and trace propagation.
- [Command Bus](https://vel.build/docs/advanced/bus/): Type-safe command dispatch with middleware, self-handling commands, and async queue delivery.
- [Collections](https://vel.build/docs/advanced/collect/): Generic, type-safe collection helpers for slices - filter, map, reduce, group, and more.
- [Pipeline](https://vel.build/docs/advanced/pipeline/): Generic, type-safe middleware-style pipeline for threading values through sequential stages.
- [Webhooks](https://vel.build/docs/advanced/webhook/): Primitives for signing, verifying, and retrying webhook deliveries.
- [Feature Flags](https://vel.build/docs/advanced/flags/): Minimal Provider interface, request-scoped overrides, and an in-memory driver for tests.
- [Events](https://vel.build/docs/advanced/events/): Build event-driven applications with Velocity's observer pattern for decoupled, extensible architecture.
- [Tracing](https://vel.build/docs/advanced/trace/): Distributed tracing primitives - trace IDs, span IDs, and parent relationships propagated through context.
- [Service Providers](https://vel.build/docs/advanced/service-providers/): Modular registration of services, routes, middleware, events, and scheduled jobs with lifecycle hooks.
- [gRPC](https://vel.build/docs/advanced/grpc/): gRPC server and HTTP gateway with context helpers, structured errors, and interceptor-friendly APIs.
- [Driver Registry](https://vel.build/docs/advanced/driver-registry/): Pluggable driver registration across cache, queue, storage, mail, notification, log, and orm subsystems.
- [Contracts](https://vel.build/docs/advanced/contract/): Minimal interfaces that break circular dependencies between core packages.