Ztack - Full Stack Zig Web Framework Overview

Ztack is an innovative and comprehensive web framework designed to empower developers to build full-stack applications entirely in Zig. It aims to eliminate the traditional "context switch" problem often faced by web developers who have to juggle different languages and ecosystems for backend and frontend development (e.g., a backend in Go/Rust and a frontend in TypeScript/JavaScript). With Ztack, you can write your server logic, database interactions, HTML generation, and even client-side browser event handlers all in the powerful, performant, and type-safe Zig language.

What is Ztack and Why is it Useful?

At its heart, Ztack allows you to leverage Zig's strengths across the entire web stack. This means a more unified development experience, fewer mental overheads switching between language paradigms, and the potential for higher performance and reliability from end-to-end. By providing tools for both server-side and client-side concerns within a single language, Ztack streamlines development and reduces the complexity typically associated with modern web applications.

Key Features

Ztack brings a suite of powerful features to achieve its full-stack vision:

• Server-Side Rendering (SSR): Generate HTML programmatically on the server using type-safe builders. This allows for robust and maintainable UI construction directly within your Zig application.

• Zig-to-JavaScript Transpilation: Write browser event handlers and other client-side logic in familiar Zig syntax. Ztack's transpiler converts a subset of Zig code into JavaScript, allowing your frontend interactions to be type-checked and managed by your Zig build system.

• WebAssembly (WASM) Support: For performance-critical client-side operations, Ztack supports compiling Zig code directly to WebAssembly. This allows you to execute highly optimized, near-native performance code directly in the browser.
• Type-Safe Routing: Define your HTTP routes with compile-time method checking, ensuring that your server handles requests predictably and securely. This reduces runtime errors and makes your API definitions robust.

• Efficient HTML Rendering: Ztack prioritizes performance in HTML generation. It streams HTML directly to the output without intermediate string buffers, uses single allocations for entire pages, and is compatible with any writer (sockets, files, etc.), leading to significant performance improvements and reduced memory usage.
• Modern Event Delegation: Employ efficient client-side event handling using data-on attributes, which Ztack integrates with a small event delegation script, reducing boilerplate and improving performance.

Quick Start

Getting started with Ztack is straightforward. After cloning the repository, you can build and run the provided examples:

These commands will compile the Zig projects and launch a local server demonstrating Ztack's capabilities.

Project Structure at a Glance

The Ztack codebase is organized to separate concerns and provide clear examples:

• src/modules/: Contains the core framework components, including:
  • router.zig: The HTTP routing framework.
  • html.zig: HTML generation utilities and builders.
  • transpiler.zig: The Zig-to-JavaScript transpilation logic.
  • js.zig: JavaScript Abstract Syntax Tree (AST) definitions.
  • dom.zig: Abstraction for browser DOM APIs.
• src/examples/: Showcases how to use the framework with various practical applications:
  • router_server.zig: A basic routing demonstration.
  • improved_counter.zig: A full-featured example demonstrating HTML builders, event delegation, and streaming.
  • wasm_simple_server.zig: An example leveraging WebAssembly.

Further Documentation

For a deeper dive into Ztack, refer to the following guides within the repository:

• QUICK_START.md: A practical guide to getting your first Ztack application running.
• API_REFERENCE.md: Comprehensive documentation of all Ztack APIs.
• IMPROVEMENTS.md: Details on the framework's architecture and design decisions.
• ZIG_SCRIPT_SUBSET.md: The specification for the Zig language subset supported by the transpiler.