Introduction

These pages are the practical documentation for SnapFire FSR. They cover what it is, how to get an application running and how the pieces fit once you have one. They sit beside the FSR guide, which is a different kind of document. The guide argues the design from first principles and reads front to back. This is the reference you keep open in another tab.

What you will find here

Welcome is orientation. It has two pages: this one and what FSR actually is.

Basics is everything you need to put a working application on a port: installing the tools, the shape of a project, routes, loaders and how a page gets its data.

Advanced covers what you reach for once the basics work: islands, hydration, actions, the session and mounting one application inside another.

Patterns holds task-shaped answers to "I want to do X", each one a block you can lift.

Diagrams has the same material drawn instead of written, for when a picture answers a question faster than a paragraph.

What FSR assumes of you

You need TypeScript and enough Rust to run cargo build. You do not need to write Rust to build an FSR application. For a long time you will not want to. The stock host reads a configuration file and serves your application. You move to your own Rust binary when you need something the configuration cannot express, which is usually not on day one.

You do not need Node.js to build, serve or test. There is no package.json in an FSR project, so do not go looking for one.

Try it

Read What SnapFire FSR is, then Getting started. It takes about twenty minutes end to end and you will have a page rendering from Rust.