Skip to content

Developer Guide

Welcome to the Contentrain Studio developer documentation. This section covers the technical details you need to deploy, extend, and contribute to Studio.

TopicDescription
ArchitectureSystem design, provider pattern, stack decisions
Self-HostingDeploy Studio on your own infrastructure
Environment VariablesComplete configuration reference
API ReferenceAll REST API endpoints
Field Types27 supported content field types
Provider InterfacesAuthProvider, DatabaseProvider, etc.
Roles & PermissionsTwo-tier role system and tool access matrix
ContributingDevelopment setup and PR process

Tech Stack

LayerTechnology
FrameworkNuxt 4 (full-stack, SSR)
UIRadix Vue + Tailwind CSS 4
AuthProvider interface (default: Supabase Auth)
DatabaseProvider interface (default: Supabase PostgreSQL + RLS)
AIClaude API (Haiku, Sonnet, Opus)
ContentContentrain format (.contentrain/ directory)
IconsAnnon custom set via @iconify/tailwind4
Package Managerpnpm

Open Core Model

Studio is licensed under AGPL-3.0 with an enterprise extension:

studio/
├── app/          # AGPL — core application
├── server/       # AGPL — server routes & providers
├── ee/           # Proprietary — enterprise features
└── ...

The AGPL core is a fully functional product. Enterprise features (ee/) add advanced capabilities like SSO, approval chains, audit logs, and white-label branding. See Enterprise Edition for the full boundary definition.

Getting Started

  1. Clone the repository and install dependencies:
bash
git clone https://github.com/Contentrain/studio.git
cd studio
pnpm install
  1. Copy the environment template and configure:
bash
cp .env.example .env
  1. Start the development server:
bash
pnpm dev

See Self-Hosting for production deployment with Docker.

Released under the AGPL-3.0 License.