- Clone the repo
gh repo clone TanStack/create-tsrouter-app
- Ensure
node
is installed - Ensure
pnpm
is installed- https://pnpm.io/installation
- Why? We use
pnpm
to manage workspace dependencies. It's easily the best monorepo/workspace experience available as of when this was written.
- Install dependencies
pnpm install
- This installs dependencies for all of the packages in the monorepo, even examples!
- Dependencies inside of the packages and examples are automatically linked together as local/dynamic dependencies.
- Run the build
pnpm build
- Build an example app with the builder
pnpm start app-js
- Run the
app-js
app just to make sure it works - Make changes to the code
- Re-run
pnpm build
andpnpm start
(in all its configurations) to make sure the changes work
- Re-run
- Check your work and PR
These must all product running applications that can be built (pnpm build
) and tested (pnpm test
).
Command | Description |
---|---|
pnpm start app-js |
Creates a JavaScript app |
pnpm start app-ts --template typescript |
Creates a TypeScript app |
pnpm start app-js-tw --tailwind |
Creates a JavaScript app with Tailwind CSS |
pnpm start app-ts-tw --template typescript --tailwind |
Creates a TypeScript app with Tailwind CSS |
pnpm start app-fr --template file-router |
Creates a TypeScript app with File Based Routing |
pnpm start app-fr-tw --template file-router --tailwind |
Creates a TypeScript app with File Based Routing with Tailwind CSS |