Documentation

Everything you need to add server-rendered HTML to your API

⚠️ Facet is still work in progress. Help us make it better by opening issues or requests on GitHub.

Getting Started

Quick Start Guide — Get Facet running in 5 minutes with Docker Compose
Product Catalog Tutorial — Guided walkthrough of a complete working application

Reference

Developer's Guide — Templates, routing, HTMX, authentication, JavaScript plugins, and configuration
Template Context Reference — All variables available in templates

Examples

Product Catalog — Full e-commerce example with search, HTMX updates, auth, CRUD, and a JavaScript plugin
All Examples — Runnable with Docker Compose

Dependencies

RESTHeart — The MongoDB REST API layer Facet is built on
Pebble Templates — The template engine (Twig/Jinja2-like syntax)

Community

GitHub Repository — Source code, issues, discussions
License — Apache License 2.0