Documentation
Documentation
Introduction

Getting Started

Getting started
Getting StartedInstallationQuick StartProject Structure

Configuration

Configuration
ConfigurationEnvironment ConfigurationEdge ConfigDatabaseAuth SecretStripeFirebaseStorageGoogle Maps And Cloud Service AccountOAuth ProvidersEmail DeliverySentryFeature Flags

Architecture

Architecture
Architecture OverviewTech StackoRPC MiddlewareDesign Principles

Patterns

Patterns
Code Patterns & ConventionsFeature ModulesError HandlingType Safety

Database

Database
DatabaseSetupSchema DefinitionDatabase OperationsMigrationsCaching
Data Tables

API

oRPCProceduresRoutersoRPC Proxy Setup
APIsOpenAPIREST Endpoints

Auth & Access

AuthenticationConfigurationOAuth ProvidersRolesSession Management
AuthorizationUser RolesPermissions

Routing & i18n

RoutingDeclarative RoutingNavigation
InternationalizationTranslationsLocale Routing

Components & UI

ComponentsButtonsFormsNavigationDialogs
StylesTailwind CSSThemingTypography

Storage

Storage
StorageConfigurationUsageBuckets
Stripe Billing

Extra

Caching

Templates

Templates
Template GuidesCreate New FeatureCreate New PageCreate Database TableCreate oRPC RouterAdd Translations

Development

Development
DevelopmentCommandsAI AgentsBest Practices
Pulling Updates

Edge Config

Configure Vercel Edge Config read and optional write access

Variables

VariableRequiredPurpose
VERCEL_EDGE_CONFIG_IDYesIdentifies the Edge Config store (ecfg_...).
VERCEL_EDGE_CONFIG_TOKENYesRead-access token for feature-flag reads.
VERCEL_API_TOKENOptionalWrite/update access from app-side operations.

Read Access (Required)

Read access requires both VERCEL_EDGE_CONFIG_ID and VERCEL_EDGE_CONFIG_TOKEN.

Steps

  1. Open Vercel Storage URL: https://vercel.com/<YOUR_ORG_SLUG>/~/stores
  2. Click Create Database.
  3. In the provider picker, select Edge Config.
  4. Choose a store name and click create.
  5. In the storage list, click the new Edge Config store row.
  6. Copy the storage ID (ecfg_...) and paste into VERCEL_EDGE_CONFIG_ID.
  7. Open Tokens from the store sidebar/menu.
  8. Click Generate Token, choose a token name, copy the generated UUID, and paste into VERCEL_EDGE_CONFIG_TOKEN.

Optional Write Access

VERCEL_API_TOKEN is only needed when your app updates Edge Config values from server-side operations.

Steps

  1. Open Vercel account tokens: https://vercel.com/account/settings/tokens
  2. Click Create Token.
  3. Fill form values:
    • Name: edge-config
    • Scope: your team (for example My Team)
    • Expiration: No expiration (or your security policy)
  4. Click Create.
  5. Copy token and save to VERCEL_API_TOKEN.

Optional Token

If your app only reads feature flags and never updates them, you can leave VERCEL_API_TOKEN unset.

Copy/Paste Mapping

VERCEL_EDGE_CONFIG_ID="ecfg_xxxxxxxxxxxxx"
VERCEL_EDGE_CONFIG_TOKEN="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# Optional
VERCEL_API_TOKEN="xxxxxxxxxxxxxxxx"

Screenshots

Vercel storage create database screen

Browse storage dialog with Edge Config selected

Edge Config store in the Vercel storage list

Edge Config details page with store ID and tokens menu

Vercel account token creation form

On this page

Variables
Read Access (Required)
Steps
Optional Write Access
Steps
Copy/Paste Mapping
Screenshots