Ziex App on Vercel

A starter template for building web applications with Ziex deployed on Vercel.

Documentation →

Getting Started

Prerequisites

1. Install ZX CLI

# Linux/macOS
curl -fsSL https://ziex.dev/install | bash

# Windows
powershell -c "irm ziex.dev/install.ps1 | iex"

2. Install Zig

brew install zig  # macOS
winget install -e --id zig.zig  # Windows

Other platforms →

3. Install Node.js (for Vercel CLI)

Download →

Project Structure

├── api/
│   └── index.ts        # Vercel Edge Function entrypoint
│   └── nodejs.ts       # Vercel Node.js Function entrypoint
├── app/
│   ├── assets/         # Static assets (CSS, images, etc)
│   ├── main.zig        # Zig entrypoint
│   ├── pages/          # Pages (Zig/ZX)
│   │   ├── layout.zx   # Root layout
│   │   ├── page.zx     # Home page
│   │   ├── client.zx   # Client-side component
│   │   └── ...
│   └── public/         # Public static files (favicon, etc)
├── build.zig           # Zig build script
├── build.zig.zon       # Zig package manager config
└── package.json

Usage

By default the app is configured to use Vercel Edge Functions. If you want to use Node.js runtime instead, update .vercelignore to remove api/nodejs.ts and update vercel.json to point to api/nodejs.ts as the entrypoint.

Development

vercel dev

App will be available at http://localhost:3000 with hot reload enabled.

Deploy to Vercel

vercel deploy

Or click the Deploy with Vercel button above for one-click deployment.

Contributing

Contributions are welcome! For feature requests, bug reports, or questions, see the Ziex Repo.

Links

• Documentation
• Discord
• Vercel Docs
• Zig Language