Skip to content

Getting Started

Template

Get started with a ready-made template quickly:

npm
npx giget@latest gh:nkzw-tech/fate-template
pnpm
pnpx giget@latest gh:nkzw-tech/fate-template
yarn
yarn dlx giget@latest gh:nkzw-tech/fate-template

The fate-template comes with a simple tRPC backend and a React frontend using fate. It features modern tools to deliver an incredibly fast development experience. Follow its README.md to get started.

Manual Installation

fate requires React 19.2+. For your client you need to install react-fate:

npm
npm add react-fate
pnpm
pnpm add react-fate
yarn
yarn add react-fate

And for your server, install the core @nkzw/fate package:

npm
npm add @nkzw/fate
pnpm
pnpm add @nkzw/fate
yarn
yarn add @nkzw/fate

WARNING

fate is currently in alpha and not production ready. If something doesn't work for you, please open a pull request.

If you'd like to try the example app in GitHub Codespaces, click the button below:

Open in GitHub Codespaces

Released under the MIT License