Engine12

A backend framework for Zig, designed for building high-performance web applications and APIs.

Quick Start

Option 1: Use CLI Tool (Recommended)

# Create a new project with recommended structure
e12 new myapp
cd myapp
zig build run

Option 2: Manual Setup

const std = @import("std");
const Engine12 = @import("engine12");

fn handleRoot(req: *Engine12.Request) Engine12.Response {
    _ = req;
    return Engine12.Response.text("Hello, World!");
}

pub fn main() !void {
    var app = try Engine12.initDevelopment();
    defer app.deinit();

    try app.get("/", handleRoot);
    try app.listen();  // Blocks until shutdown
}

Installation

Step 1: Fetch the package

Run zig fetch to add Engine12 to your build.zig.zon:

zig fetch --save "git+https://github.com/ooyeku/engine12.git"

This will automatically add the dependency with the correct hash to your build.zig.zon file.

Alternatively, you can manually add it to your build.zig.zon:

.dependencies = .{
    .engine12 = .{
        .url = "git+https://github.com/ooyeku/engine12.git",
        .hash = "...", // Run `zig fetch` to get the hash
    },
},

Step 2: Add to your build.zig

Add the dependency and module to your build.zig:

const engine12_dep = b.dependency("engine12", .{
    .target = target,
    .optimize = optimize,
});

exe.addModule("engine12", engine12_dep.module("engine12"));

If you're using the ORM, you'll also need to link libc:

// Link libc (required for ORM/SQLite functionality)
exe.linkLibC();

Features

• High Performance - Multi-threaded request handling with configurable worker threads (default: 12)
• HTTP Routing - GET, POST, PUT, DELETE, PATCH with route parameters
• Server Configuration - Configurable host, port, timeouts, and worker threads via configure()
• WebSocket Support - Real-time bidirectional communication with room management
• HTMX Integration - Zero-configuration HTMX support with form parsing, error helpers, and response builders (auto-enabled in development)
• Hot Reloading - Automatic template and static file reloading in development mode
• Auto-Discovery - Automatic migration, static file, and template discovery to reduce boilerplate
• Project Scaffolding - CLI tool (e12 new) to generate projects with recommended structure
• Structured Logging - JSON and human-readable logging with multiple destinations (stdout, file, syslog)
• Middleware System - Pre-request and response middleware chains
• SQLite ORM - Type-safe database operations with automatic table pluralization, upsert support, managed memory, and parameter binding for SQL injection prevention
• Template Engine - Server-side HTML rendering
• Request/Response API - Clean, memory-safe HTTP handling with struct-to-JSON convenience methods
• Rate Limiting - Per-route rate limiting
• CSRF Protection - Built-in CSRF token validation
• Metrics & Health Checks - Request timing and health monitoring
• Background Tasks - Periodic and one-time task scheduling
• Static File Serving - Serve static assets
• OpenAPI/Swagger Documentation - Automatic API documentation generation with Swagger UI

Documentation

• API Reference - Complete API documentation
• Tutorial - Step-by-step guide to building your first app
• Architecture Guide - System design and architecture
• Examples - Complete todo app walkthrough
• Troubleshooting - Common issues and solutions

Example

See the todo app example for a complete working application demonstrating:

• Database setup and migrations
• CRUD operations with the ORM
• Template rendering
• Route handlers
• Frontend integration

Requirements

• Zig 0.15.1 or later

License

MIT License - see LICENSE file for details.

Contributing

Contributions welcome! Please see our contributing guidelines.