uf

A toolchain for React and Modern Flow.

Getting started · Documentation · Reference · Releases

uf provides development builds, production builds, tests, formatting, linting and type checking through one native CLI and one uf.config.js. It uses the official Flow parser, React Compiler and Vite.

uf is at 0.x, and that still means commands, configuration and package APIs may change between releases; a minor release (0.1.0 to 0.2.0) may break them, and its notes say how. See the release notes and current capabilities.

Install

On macOS or Linux:

curl -fsSL https://setup.uniflowed.dev | sh

On Windows, use PowerShell:

irm https://setup.uniflowed.dev/install.ps1 | iex

You also need a JavaScript host such as Node.js. The installation guide covers supported hosts, download verification, PATH setup, Nix and building from source.

Create a project

uf new my-app
cd my-app
uf install
uf dev

Run uf test to test the project and uf build to create a production build. Your first project explains the files and common commands. Build a reading list walks through routes, shared state, forms and tests.

Documentation

• Getting started: installation, projects and editor setup.
• Build an app: routing, data, state and UI.
• Reference: commands, configuration and package APIs.
• Migrating to uf: use uf with an existing application.

Examples

• SPA task board: client rendering, shared state and static hosting.
• GraphQL SNS: Relay and server data.
• Native SNS: React Native.

Contributing

See CONTRIBUTING.md for local setup and checks, the architecture for the implementation, and the roadmap for planned work.

License

MIT