Overview

View Source
Macula Logo

Macula HTTP/3 Mesh

A distributed platform for decentralized applications

License Erlang/OTP

Table of Contents

📖 Executive Summary - What Macula is and why it matters

🚀 Quick Start - Get running in 15 minutes

💡 Hello World Tutorial - Build a distributed chat app in 30 minutes

📚 Technical Documentation - Complete architecture and implementation guides

🔧 Development Guide - Setup, testing, and contributing

🏗️ Comparisons - How Macula compares to similar systems

📊 Use Cases - Real-world applications and examples

📝 Project Structure - Module organization and dependencies

🗺️ Roadmap - 20-week implementation plan

📄 Changelog - Version history and migration guides

What is Macula?

Macula is infrastructure for building decentralized applications and services that operate autonomously at the edge, without dependency on centralized cloud infrastructure.

Key Features:

✅ BEAM-native (Erlang/Elixir OTP supervision and fault tolerance) ✅ HTTP/3 (QUIC) transport (modern, encrypted, NAT-friendly) ✅ Edge-first design (works through firewalls and NAT) ✅ Built-in pub/sub & RPC (no external message broker needed) ✅ Multi-tenancy (realm isolation for SaaS and shared infrastructure) ✅ Self-organizing mesh (DHT-based service discovery, O(log N) routing) ✅ Production-ready patterns (OTP behaviors, comprehensive testing, memory management)

Installation

Elixir (mix.exs):

def deps do
  [
    {:macula, "~> 0.6"}
  ]
end

Erlang (rebar.config):

{deps, [
    {macula, "0.6.6"}
]}.

Development Setup

# Clone the repository
git clone https://github.com/macula-io/macula.git
cd macula

# Fetch dependencies
rebar3 get-deps

# Compile
rebar3 compile

# Run tests
rebar3 eunit

# Start a shell with Macula loaded
rebar3 shell

Contributing

We welcome contributions! See Development Guide for setup instructions and Contributing Guide for guidelines.

License

Macula is licensed under the Apache License 2.0. See LICENSE for details.

Community & Support

Built with ❤️ for the BEAM community