Skip to content

README.md for TanStack React Start created apps says run "pnpm install", "pnpm start", but there is no "start" script #228

@bhouston

Description

@bhouston

Which project does this relate to?

Create Tanstack App

Describe the bug

Just create a TanStack React Start app with default settings and then the README tells you to do something that doesn't work:

Image

There is no "start" script! It just errors out. Also if you run manually "pnpm vite start" it gives you a blank screen.

The TanStack Start docs say do this for a "start" script:

https://tanstack.com/start/latest/docs/framework/react/guide/hosting#nodejs--railway--docker

"start": "node .output/server/index.mjs"

But there is no current .output directory anymore created by the TanStack React Start CLI app, it is a "dist/server/server.js" file, but also if you just do add this:

"start": "node dist/server/server.js" it does nothing.

Your Example Website or App

https://github.com/bhouston/tan_stack_starter

Steps to Reproduce the Bug or Issue

  1. Generate a new TanStack React Start app via the CLI tool. I do not think it matters which options, I tried the default options.

  2. IF you follow the README.md and run "pnpm install", "pnpm start", it does nothing.

So the default starter app is broken based on its readme.

Expected behavior

It should do something. It shouldn't be broken out of the box. Change the README.md to run "pnpm dev", since there isn't a build script run first.

Also add a "start" or "serve" script that shows how to run the CLI-created app in production that works. Because the docs are not sufficient.

Screenshots or Videos

Image

Platform

  • OS: MacOS
  • Browser: None
  • Version: 1.132.0

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions