vix-registry

High-performance package registry engine built on Vix.cpp (C++).

---

About

vix-registry is a real-world Vix application that demonstrates how to build a high-performance registry service in modern C++.

It showcases:

• Clean application structure on top of Vix.cpp
• Modern CMake workflow via CMakePresets.json
• Hot-reload and fast iteration
• Optional integration with Vix ORM
• A solid foundation for building a production-grade package registry

This project is not just an example — it is the reference implementation of a registry service powered by Vix.

Overview — What is Vix Registry?

Vix Registry is a generic, high-performance package registry engine designed to serve as the backbone for distributing packages, artifacts, and versioned resources in modern C++ ecosystems.

Its primary goal is to provide a fast, reliable, and extensible registry similar in spirit to:

• npm registry (JavaScript)
• PyPI (Python)
• crates.io (Rust)
• Docker Registry (OCI)

…but built natively in C++, on top of Vix.cpp, with a strong focus on:

• performance
• simplicity
• long-term maintainability

Vix Registry is not tied to a single language or package format. Instead, it exposes a clean HTTP API that can be used by:

• CLI tools
• SDKs
• CI/CD systems
• Build tools
• Internal infrastructure

---

How Vix Registry Is Intended to Be Used

1. As the official registry for the Vix ecosystem

Vix Registry is designed to be the official registry backend for:

• Vix packages
• Vix plugins and extensions
• Prebuilt artifacts
• Metadata and version resolution

Example use cases:

• vix install my-lib
• vix publish
• vix update

The registry handles:

• package ownership
• versioning (SemVer)
• authentication tokens
• download integrity (hashes)
• access control (public / private packages)

---

2. As a standalone registry service

Vix Registry can also be deployed as a standalone service for:

• private package registries
• internal company tooling
• artifact distribution
• on-premise or cloud environments

Because it is built as a regular Vix application, it can be:

• deployed behind Nginx
• containerized (Docker / Kubernetes)
• integrated into existing infrastructure

---

3. As a reference architecture for Vix applications

Beyond the registry itself, this project serves as a reference Vix app:

• Clean separation of:
  • HTTP layer
  • domain logic
  • services
  • storage
• Production-grade project layout
• Real-world usage of:
  • routing
  • configuration
  • authentication
  • storage abstraction
  • testing

This makes vix-registry a practical blueprint for building large-scale applications on top of Vix.cpp.

---

High-Level Flow

Client (CLI / SDK / CI)
        |
        |  HTTP API
        v
  Vix Registry (Vix.cpp)
        |
        +-- Auth / Tokens
        +-- Package & Version services
        +-- Storage (FS / DB / Object storage)

---

Non-goals (for clarity)

Vix Registry is not:

1. a frontend UI
2. a build system
3. a package manager client

It focuses exclusively on being a robust registry backend. Clients and tooling are expected to live outside this repository.

---

Features

• Simple HTTP server powered by vix::App
• Modern C++20 codebase
• Cross-platform build setup via CMake presets
• Hot reload dev mode: rebuild & restart on save (vix dev)
• Optional sanitizers (VIX_ENABLE_SANITIZERS)
• Optional ORM (VIX_USE_ORM=ON)

---

Project Structure

registry/
├── CMakeLists.txt
├── CMakePresets.json
├── Makefile
├── README.md
├── CHANGELOG.md
├── LICENSE
├── .gitignore
├── config/
│   ├── config.dev.json
│   ├── config.prod.json
│   └── config.local.example.json
├── docs/
│   ├── architecture.md
│   ├── api.md
│   ├── storage.md
│   ├── security.md
│   └── roadmap.md
├── migrations/
│   ├── 0001_init_schema.sql
│   ├── 0002_add_tokens.sql
│   └── ...
├── scripts/
│   ├── dev.sh
│   ├── migrate.sh
│   └── seed.sh
├── infra/
│   ├── docker-compose.yml
│   ├── Dockerfile
│   ├── nginx.conf
│   └── k8s/
├── include/
│   └── vix/registry/
│       ├── App.hpp
│       ├── http/
│       │   ├── HttpServer.hpp
│       │   ├── Routes.hpp
│       │   └── Middleware.hpp
│       ├── domain/
│       │   ├── Package.hpp
│       │   ├── Version.hpp
│       │   ├── User.hpp
│       │   ├── Token.hpp
│       │   └── errors.hpp
│       ├── services/
│       │   ├── PackageService.hpp
│       │   ├── VersionService.hpp
│       │   └── AuthService.hpp
│       ├── storage/
│       │   ├── IPackageStorage.hpp
│       │   ├── LocalFileStorage.hpp
│       │   └── S3Storage.hpp
│       └── db/
│           ├── Database.hpp
│           ├── PackageRepository.hpp
│           └── UserRepository.hpp
├── src/
│   ├── main.cpp
│   ├── App.cpp
│   ├── http/
│   │   ├── HttpServer.cpp
│   │   ├── Routes.cpp
│   │   └── Middleware.cpp
│   ├── domain/
│   │   ├── Package.cpp
│   │   ├── Version.cpp
│   │   ├── User.cpp
│   │   └── Token.cpp
│   ├── services/
│   │   ├── PackageService.cpp
│   │   ├── VersionService.cpp
│   │   └── AuthService.cpp
│   ├── storage/
│   │   ├── LocalFileStorage.cpp
│   │   └── S3Storage.cpp
│   └── db/
│       ├── Database.cpp
│       ├── PackageRepository.cpp
│       └── UserRepository.cpp
├── tests/
│   ├── CMakeLists.txt
│   ├── unit/
│   │   ├── test_package.cpp
│   │   ├── test_services.cpp
│   │   └── test_auth.cpp
│   └── integration/
│       ├── test_publish.cpp
│       └── test_resolve.cpp
└── examples/
    ├── curl/
    │   ├── publish_package.http
    │   ├── get_package.http
    │   └── download_version.http
    └── clients/
        ├── vix_client_example.md
        └── python_client_example.py

---

Requirements

• CMake ≥ 3.20
• C++20 compiler
  • Linux/macOS: Clang ≥ 15 or GCC ≥ 11
  • Windows: Visual Studio 2022 (MSVC 19.3+)
• Vix.cpp installed (system install or local build)

---

Build & Run (Vix CLI)

vix build        # Configure & build
vix run          # Run (builds if needed)
vix dev          # Hot reload: rebuild & restart on save

Enable ORM (optional)

If your Vix installation exports vix::orm, you can enable it like this:

vix build -D VIX_USE_ORM=ON
vix run   -D VIX_USE_ORM=ON
vix dev   -D VIX_USE_ORM=ON

If vix::orm is not available in your install, CMake will fail with a clear error.

---

Manual CMake (optional)

cmake --preset dev-ninja
cmake --build --preset dev-ninja

Windows (Visual Studio 2022)

cmake --preset dev-msvc
cmake --build --preset dev-msvc

---

Useful Commands

Command	Description
vix build	Build the project
vix run	Run the project
vix dev	Hot reload (watch + rebuild + restart)
vix help	Show CLI help

---

Example Output

When the server starts successfully, you’ll see logs like:

[I] Config loaded from .../config.json
[I] [ThreadPool] started with threads=...
[I] Acceptor initialized on port 8080
[I] Server request timeout set to 5000 ms

Open http://localhost:8080/ in your browser.

---

About Vix.cpp

Vix.cpp is a high-performance, modular C++ backend runtime inspired by FastAPI, Express.js, and modern tooling.

• Clean routing (app.get("/", ...))
• Modular architecture (core, utils, json, websocket, orm, ...)
• Simple CMake integration for external apps

---

License

MIT © Vix.cpp Authors