Caravela

Declare your domain. Sail with the generated code.

A schema-driven, composable full-stack framework for Phoenix projects. Describe a domain (entities, fields, relations, hooks, permissions) as an Elixir DSL; Caravela generates Ecto schemas, migrations, Phoenix contexts, JSON controllers, Absinthe schemas, and a Svelte frontend layer that works under both LiveView's WebSocket transport and an Inertia-style HTTP transport — per entity, via frontend: :live or frontend: :rest.

defmodule MyApp.Domains.Library do
  use Caravela.Domain, multi_tenant: true

  version "v1"

  entity :books, frontend: :rest do
    field :title, :string, required: true, min_length: 3
    field :published, :boolean, default: false
  end

  entity :authors do
    field :name, :string, required: true
  end

  policy :books do
    allow :create, fn actor -> actor.role in [:admin, :editor] end
  end
end

mix caravela.gen MyApp.Domains.Library
mix caravela.gen.live MyApp.Domains.Library

Install

{:caravela, "~> 0.13"},
{:caravela_svelte, "~> 0.1"}  # required for mix caravela.gen.live output

Documentation

• 📘 HexDocs: https://hexdocs.pm/caravela
• 🌐 Site: https://rsousacode.github.io/Caravela

Full guides live under docs/ and ship with the Hex package.

• Getting started
• DSL reference
• Generators
• Multi-tenancy
• API versioning
• GraphQL with Absinthe
• Svelte frontend (render modes)
• Live runtime (Caravela.Live.*)
• Flows — async workflow orchestration
• Regeneration & the CUSTOM marker
• Authentication (authenticatable)
• Policies — triple-target authorization
• Validation — structured errors + gettext
• Testing Caravela
• MCP server — Caravela as an LLM tool surface

Run mix docs to build the full API reference locally (HexDocs-style).

Status

Phases 1–9 are in place: DSL + compiler, Ecto schemas + migrations, hooks + permissions, Phoenix contexts, JSON API, Absinthe/GraphQL, multi-tenancy, API versioning, the Caravela.Live.* runtime, dynamic Svelte forms, a GenServer-backed flow runtime (Caravela.Flow), trait-based authentication (authenticatable + mix caravela.gen.auth), and triple-target policies — one policy block compiles into Ecto WHERE clauses, field projection, action gates, and typed field_access + actions Svelte props, all enforced server-side.

Caravela v0.11 introduced render modes: entity :x, frontend: :live still produces LiveView + WebSocket, while frontend: :rest produces a Phoenix controller rendering Svelte pages over an Inertia-style HTTP transport. Both modes share a single Svelte component tree and prop contract via caravela_svelte.

v0.12 ships Caravela.Router (caravela_routes/1) and Caravela.ChangesetTranslator (structured errors with gettext/ICU plumbing). v0.13 ships auto-generated ExUnit + Vitest test skeletons and action-level policy access (Delete / Edit / Create button gating on the policy engine). The MCP server lets LLM hosts read the domain IR directly via mix caravela.mcp.

License

MPL-2.0 — see LICENSE and NOTICE.

Use Caravela freely, including in closed-source apps. Modifications to Caravela source files must stay under MPL-2.0 with attribution.

Support the project

Caravela is built in the open and free to use. Donation channels will be linked here once set up. PRs, bug reports, and kind words all help keep the sails full.