Cinder Frontend Documentation

Welcome to the official documentation for the Cinder Frontend. A modern, type-safe web interface for the Cinder Scraper backend built with SvelteKit 5, Svelte 5 Runes, and Tailwind CSS v4.

Quick Start

Try Playground

Test scraping, crawling, and search interactively with your backend.

Setup Guide

Get the frontend up and running in minutes.

Architecture

Understand the technical design and data flow.

Technology Stack

Frontend

SvelteKit 5 Framework

Svelte 5 Runes Reactivity

Tailwind CSS v4 Styling

Backend Communication

Remote Functions RPC

Valibot Validation

TypeScript Type Safe

UI Components

shadcn-svelte Primitives

Bits UI Headless

Lucide Icons Icons

Security

Private API Keys Server-side

No Trackers Privacy

Type Safety Validation

Key Principles

Modern Development

Built with Svelte 5 runes, Remote Functions, and type-safe patterns for a delightful developer experience.

Open Source First

Easy to self-host with minimal configuration. Deploy anywhere with zero lock-in.

Privacy Focused

No external trackers. Direct communication with your backend. Your data stays yours.

Lightning Fast

Optimized bundle size, lazy loading, and efficient state management for snappy performance.

Developer Friendly

Clean code with TypeScript, well-documented, and following modern Svelte 5 patterns.

Documentation

Getting Started

Introduction and setup guide

Architecture Design

Technical design, data flow, and patterns

Features Overview

Scrape, Crawl, and Search capabilities

User Flows

How users interact with the app

Theme & Styling

Customize colors and design tokens

Need Help?

Check out the setup guide to get started, explore the architecture to understand how everything works, or browse the features to see what's possible.

Open Playground View Setup Guide

Cinder Docs