Skip to content

Zig-Index/registry

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Zig Index Registry

Zig Index is an independent and unofficial registry of Zig projects. It is not affiliated with, endorsed by, or maintained by the Zig Software Foundation or any of its founders. All projects listed on this website are owned and maintained by their respective developers and the community. No ownership or responsibility is claimed over any third-party software hosted or indexed. I do not own or claim any rights to trademarks, logos, or names referenced or displayed; all such assets belong to their respective owners.

Update: Based on community feedback, the registry functionality has been changed to be fully automated! no need for Fork PR anymore, Thank you for all your feedback! All new projects will appear on the live site within few hours automatically!

🌟 Overview

Zig Index is a community-driven registry for discovering and sharing Zig projects. It provides:

  • πŸ“¦ Project Discovery: Browse and search through curated Zig projects
  • πŸš€ Project Showcase: Find tools and software built with Zig
  • πŸ“Š Live Statistics: Real-time GitHub stats (stars, forks, issues)
  • πŸ“– README Display: View project documentation directly
  • πŸ”§ Installation Commands: Copy-to-clipboard zig fetch commands
  • πŸ‘€ Developer Profiles: View contributors and their Zig projects
  • πŸ” Advanced Search: Filter by category, license, topic, and more

πŸ“ Structure

database/
β”œβ”€β”€ username/              # GitHub username or organization
β”‚   β”œβ”€β”€ repo-name.json     # Repository details
β”‚   └── another-repo.json
└── another-user/
    └── project.json

βž• Adding Your Project

Add GitHub Topics

You must add one of the following topics to your GitHub repository:

  • For Packages: Add zig-package
  • For Applications: Add zig-application

Optionally, you can also add zig-index to show support.

πŸ”§ Installation

For Projects

Users can install projects directly using zig fetch:

# Using .tar.gz (recommended)
zig fetch --save https://github.com/{owner}/{repo}/archive/refs/tags/{version}.tar.gz

# Using .zip
zig fetch --save https://github.com/{owner}/{repo}/archive/refs/tags/{version}.zip

For repositories without releases, the main branch is used:

# Main branch (latest commit)
zig fetch --save https://github.com/{owner}/{repo}/archive/refs/heads/main.tar.gz

The website automatically generates these commands with copy-to-clipboard functionality!

build.zig.zon Integration

After running zig fetch --save, add the dependency to your build.zig:

const std = @import("std");

pub fn build(b: *std.Build) void {
    const target = b.standardTargetOptions(.{});
    const optimize = b.standardOptimizeOption(.{});

    // Add dependency
    const dep = b.dependency("package-name", .{
        .target = target,
        .optimize = optimize,
    });

    const exe = b.addExecutable(.{
        .name = "my-app",
        .root_source_file = b.path("src/main.zig"),
        .target = target,
        .optimize = optimize,
    });

    // Import module from dependency
    exe.root_module.addImport("package-name", dep.module("package-name"));
    
    b.installArtifact(exe);
}

πŸ“œ Guidelines

Do Submit

  • βœ… Open source Zig projects on GitHub
  • βœ… Projects with build.zig or build.zig.zon
  • βœ… Well-documented projects with READMEs
  • βœ… Active projects (updated within the last year)

Don't Submit

  • ❌ Closed source projects
  • ❌ Non-Zig projects
  • ❌ Abandoned/archived repositories
  • ❌ Forks without significant changes
  • ❌ Tutorial/example code (unless it's a library)

πŸ› οΈ Development

Prerequisites

  • Node.js 18+
  • npm or pnpm

Local Development

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Tech Stack

πŸ“„ License

This registry is open source under the MIT License.

πŸ”— Links

🀝 Contributing

We welcome contributions! Here's how you can help:

  1. Add Projects: Add zig-index & zig-package/zig-application topics to your repo
  2. Report Issues: Found a bug? Open an issue
  3. Improve Code: PRs for bug fixes and features welcome
  4. Spread the Word: Share Zig Index with the community!

Made with ❀️ by the Zig Community

About

The unofficial registry of Zig packages and applications projects for Zig Index.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5