Welcome to TanStack.com!

This site is built with TanStack Router!

• TanStack Router Docs

It's deployed automagically with Netlify!

• Netlify

Development

From your terminal:

pnpm install
pnpm dev

This starts your app in development mode, rebuilding assets on file changes.

Authentication in Development

The dev server uses the production database and real OAuth, so dev and production behave identically. To authenticate your local session, run:

pnpm auth:login

This opens tanstack.com in your browser. Sign in with GitHub or Google, and the resulting session token is saved to .env.local as DEV_SESSION_TOKEN. Restart the dev server and you will be signed in automatically.

To authenticate against a locally running server instead:

pnpm auth:login --url http://localhost:3000

Note

The token is a real signed session cookie tied to your production account. It expires in 30 days. Re-run pnpm auth:login to refresh it.

Note

If you are using an AI agent (Claude, Cursor, etc.) to help develop, run pnpm auth:login once before starting your session so the agent can interact with authenticated features on your behalf.

Editing and previewing the docs of TanStack projects locally

The documentations for all TanStack projects except for React Charts are hosted on https://tanstack.com, powered by this TanStack Router app. In production, the markdown doc pages are fetched from the GitHub repos of the projects, but in development they are read from the local file system.

Follow these steps if you want to edit the doc pages of a project (in these steps we'll assume it's TanStack/form) and preview them locally :

1. Create a new directory called tanstack.

mkdir tanstack

2. Enter the directory and clone this repo and the repo of the project there.

cd tanstack
git clone git@github.com:TanStack/tanstack.com.git
git clone git@github.com:TanStack/form.git

Note

Your tanstack directory should look like this:

tanstack/
   |
   +-- form/
   |
   +-- tanstack.com/

Warning

Make sure the name of the directory in your local file system matches the name of the project's repo. For example, tanstack/form must be cloned into form (this is the default) instead of some-other-name, because that way, the doc pages won't be found.

3. Enter the tanstack/tanstack.com directory, install the dependencies and run the app in dev mode:

cd tanstack.com
pnpm i
# The app will run on https://localhost:3000 by default
pnpm dev

4. Now you can visit http://localhost:3000/form/latest/docs/overview in the browser and see the changes you make in tanstack/form/docs.

Note

The updated pages need to be manually reloaded in the browser.

Warning

You will need to update the docs/config.json file (in the project's repo) if you add a new doc page!