Skip to content

README.md

Latest commit

 

History

History
50 lines (37 loc) · 2.46 KB

README.md

File metadata and controls

50 lines (37 loc) · 2.46 KB

The WarpKit Guide

A comprehensive guide to building single-page applications with WarpKit — the Svelte 5 SPA framework with state-based routing, type-safe data fetching, schema-driven forms, and real-time WebSocket support.

Who This Guide Is For

This guide is for frontend developers who want to build robust, production-ready single-page applications with Svelte 5. Whether you're starting a new project or evaluating WarpKit for an existing one, this guide will take you from zero to deep understanding.

Prerequisites:

  • Familiarity with Svelte (ideally Svelte 5 and runes)
  • Basic TypeScript knowledge
  • Understanding of SPAs (single-page applications) vs. multi-page apps

Table of Contents

Getting Started

  1. Introduction & Philosophy — What WarpKit is, why it exists, and the design principles behind it
  2. Quick Start — Get a WarpKit app running in 5 minutes

Core Concepts

  1. State-Based Routing — The core innovation: routes organized by application state
  2. The Navigation Pipeline — How every navigation flows through 10 predictable phases
  3. The Provider System — Pluggable abstractions for browser APIs

Building Features

  1. Data Fetching & Caching — Config-driven data layer with E-Tag caching
  2. Forms & Validation — Schema-driven forms with deep proxy binding
  3. WebSockets & Real-Time — Type-safe real-time communication
  4. Authentication — Pluggable auth adapter pattern

Advanced Topics

  1. Testing — Mock providers, assertion helpers, and testing strategies
  2. Architecture & Design Decisions — Why WarpKit is built the way it is

Package Overview

Package Purpose
@warpkit/core Router, state machine, events, components
@warpkit/data Data fetching, caching, mutations
@warpkit/cache MemoryCache, StorageCache, ETagCacheProvider
@warpkit/forms Schema-driven form state management
@warpkit/validation StandardSchema validation utilities
@warpkit/websocket WebSocket client with reconnection
@warpkit/auth-firebase Firebase authentication adapter
@warpkit/types Shared TypeScript types

License

WarpKit is open source software.