Skip to content

Starters Documentation #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jherr opened this issue May 12, 2025 · 0 comments
Open

Starters Documentation #102

jherr opened this issue May 12, 2025 · 0 comments

Comments

@jherr
Copy link
Collaborator

jherr commented May 12, 2025

Which project does this relate to?

Create Tanstack App

Describe the bug

Document how to create and maintain starters.

  1. To create a starter, build an application using the file-router, tailwind, and whatever add-ons you want.
  2. Make any modifications you want.
  3. Run pnpx create-tsrouter-app@latest starter init to create the starter.
  4. Run pnpx create-tsrouter-app@latest starter compile to compile the starter if you have made further modifications.
  5. Post the project to github

To use the starter during application creation use the UI: pnpx create-tsrouter-app@latest --ui Then click on the Set Starter button and give it the URL of the starter.json file (probably on GitHub).

Also there should be information on how to add a banner graphic (which is probably just a screenshot of the starter site.)

Your Example Website or App

https://github.com/TanStack/create-tsrouter-app

Steps to Reproduce the Bug or Issue

  1. Go to https://github.com/TanStack/create-tsrouter-app
  2. Notice there are no docs on how to create starters

Expected behavior

That there be some good docs for this feature.

Screenshots or Videos

No response

Platform

  • OS: [e.g. macOS, Windows, Linux]
  • Browser: [e.g. Chrome, Safari, Firefox]
  • Version: [e.g. 91.1]

Additional context

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant