Readiness: Implemented

Start

Getting started

Most read

1. Start hereInstallInstall uf on macOS, Linux or Windows.
2. Your first projectCreate, run, test and build a React application.
3. What you can doEvery goal uf covers, its status, and the pages to read in order to get there.
4. Build a reading listBuild a React application with routes, shared state, a form and tests.
5. Flow, the modern partscomponent, hook, renders, match and enums — and what uf does with them.

Before you start

• Use macOS or Linux on x86-64 or ARM64, or Windows on x86-64.
• Install a JavaScript host such as Node.js. Bun and Deno 2.8+ are also supported; see runtime details.
• Be familiar with React components and hooks. The guides explain Flow syntax as it appears.

Follow the guides

1. What you can doEvery goal uf covers, its status, and the pages to read in order to get there.
2. InstallInstall uf on macOS, Linux or Windows.
3. Your first projectCreate, run, test and build a React application.
4. IDE setupSet up uf in VS Code, Cursor, Zed, JetBrains, Neovim, Vim, Helix or Emacs, with project settings and shared language-server guidance.
5. Flow, the modern partscomponent, hook, renders, match and enums — and what uf does with them.
6. Build a reading listBuild a React application with routes, shared state, a form and tests.

What you can do maps each goal — a new app, tests, checks, deployment, UI, data — to the pages that get you there, with its status. Then start with installation, then create your first project. Follow IDE setup, read Flow, the modern parts for the syntax every example uses, and follow the reading-list tutorial to add routes, state, forms and tests.

Other paths

The toolchain is next: the commands you run every day. Build an app has guides for individual features. Migrating to uf covers existing applications. Why uf explains the project's goals and tradeoffs.

Edit this pagedocs/app/guide/start/$page.mdx