Skip to content

README lists incorrect command to run the app #258

@Daniel15

Description

@Daniel15

Which project does this relate to?

Start

Describe the bug

I created a new TanStack Start app using:

npm create @tanstack/start@latest

I answered the questions as following:

  • Tailwind CSS: No
  • Toolchain: ESLint
  • Deployment adapter: Nitro
  • Add-ons: Shadcn, T3Env
  • Examples: none

It says to read the README. The generated README.md says this:

Welcome to your new TanStack app! 

# Getting Started

To run this application:

npm install
npm run start

However, there is no npm command named "start". It's actually supposed to be "dev":

  "scripts": {
    "dev": "vite dev --port 3000",
    "build": "vite build",
    "preview": "vite preview",
    "test": "vitest run",
    "lint": "eslint",
    "format": "prettier",
    "check": "prettier --write . && eslint --fix"
  },

Your Example Website or App

N/A

Steps to Reproduce the Bug or Issue

As above

Expected behavior

Readme should say to run npm run dev.

Screenshots or Videos

No response

Platform

  • Router / Start Version: [e.g. 1.121.0]
  • OS: [e.g. macOS, Windows, Linux]
  • Browser: [e.g. Chrome, Safari, Firefox]
  • Browser Version: [e.g. 91.1]
  • Bundler: [e.g. vite]
  • Bundler Version: [e.g. 7.0.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