better-ts-stack 2.0.1 → 2.1.0

package/README.md

@@ -1,113 +1,114 @@
-# better-ts-stack
-
-> A CLI that scaffolds TypeScript backend and full-stack projects.
-
-`better-ts-stack` creates an Express, NestJS, Next.js, or TanStack Start project with TypeScript, ESLint, and Prettier set up. Database, authentication, Docker, and git are optional.
-
-## Quick Start
-
-```bash
-# Run instantly with npx
-npx better-ts-stack
-
-# Or install globally
-npm install -g better-ts-stack
-better-ts-stack
-```
-
-Run the command and answer the prompts. The CLI creates the project folder.
-
-## Flags
-
-Every prompt has a flag. Options you leave out are asked interactively, unless you pass `--yes`.
-
-```bash
-# No prompts at all
-npx better-ts-stack my-api --framework nestjs --database prisma --auth --yes
-
-# Create the project in the current (empty) directory
-npx better-ts-stack . --framework nextjs --database drizzle --pm pnpm
-```
-
-| Flag                         | Values                                       |
-| ---------------------------- | -------------------------------------------- |
-| `--framework <name>`         | `express`, `nestjs`, `nextjs`, `tanstack`    |
-| `--database <name>`          | `none`, `prisma`, `drizzle`, `mongoose`      |
-| `--pm <name>`                | `npm`, `pnpm`, `bun`                         |
-| `--auth` / `--no-auth`       | Add authentication                           |
-| `--docker` / `--no-docker`   | Add Docker files                             |
-| `--git` / `--no-git`         | Initialize a git repository                  |
-| `--install` / `--no-install` | Install dependencies                         |
-| `-y`, `--yes`                | Use defaults for missing options, no prompts |
-| `--dry-run`                  | List what would be created, write nothing    |
-| `-h`, `--help`               | Show help                                    |
-| `-v`, `--version`            | Show the version                             |
-
-`--database` names the ORM, which also selects the database: `prisma` and `drizzle` use PostgreSQL, `mongoose` uses MongoDB.
-
-With `--yes`, the defaults are Express, no database, no auth, no Docker, npm, git initialized, and dependencies not installed.
-
-The project path can be a name (`my-app`), a nested path (`apps/api`), or `.` for the current directory.
-
-## What It Can Scaffold
-
-| Project type   | Stack                                   | Optional setup                                                           |
-| -------------- | --------------------------------------- | ------------------------------------------------------------------------ |
-| Backend API    | Express 5 or NestJS 12 + TypeScript     | PostgreSQL, MongoDB, Prisma, Drizzle, Mongoose, JWT auth, Docker, git    |
-| Full-stack app | Next.js 16 or TanStack Start + React 19 | PostgreSQL, MongoDB, Prisma, Drizzle, Mongoose, Better Auth, Docker, git |
-
-Notes:
-
-- Better Auth is only offered for full-stack projects that use a database.
-
-## Interactive Prompt Flow
-
-Without flags, the CLI asks, in order:
-
-1. Project name or path
-2. Application type: `Backend API` or `Full-stack App`
-3. Framework
-   - Backend: `Express` or `NestJS`
-   - Full-stack: `Next.js` or `TanStack Start`
-4. Database: `none`, `PostgreSQL`, or `MongoDB`
-5. ORM/ODM when a database is selected
-   - PostgreSQL: `Prisma` or `Drizzle`
-   - MongoDB: `Mongoose`
-6. Package manager: `npm`, `pnpm`, or `bun`
-7. Docker setup
-8. Authentication
-   - Express and NestJS apps: JWT-based auth
-   - Next.js and TanStack Start apps: Better Auth, only when a database is selected
-9. Git initialization
-10. Dependency installation
-
-The CLI does not ask for a port. Backend projects default to `PORT=3000`.
-
-## What You Get
-
-Every generated project includes:
-
-- TypeScript with strict mode enabled
-- ESLint and Prettier pre-configured
-- `.env.example` and `.env` setup
-- Ready-to-run project scripts
-- Health check endpoint at `/health` for backend projects
-- shadcn-compatible UI components for Next.js and TanStack Start projects
-- Database wiring and schema setup when selected
-- Authentication scaffolding when selected
-- Docker files when selected
-- Optional git repository initialization
-
-## Requirements
-
-- Node.js 24 or later
-
-## Links
-
-- [Documentation](https://better-ts-stack.abdullahtech.me/docs)
-- [GitHub Repository](https://github.com/Abdullah-dev0/better-ts-stack)
-- [Issue Tracker](https://github.com/Abdullah-dev0/better-ts-stack/issues)
-
-## License
-
-MIT
+# better-ts-stack
+
+> A CLI that scaffolds TypeScript backend and full-stack projects.
+
+`better-ts-stack` creates an Express, NestJS, Next.js, or TanStack Start project with TypeScript, ESLint, and Prettier set up. Database, authentication, Docker, and git are optional.
+
+## Quick Start
+
+```bash
+# Run instantly with npx
+npx better-ts-stack
+
+# Or install globally
+npm install -g better-ts-stack
+better-ts-stack
+```
+
+Run the command and answer the prompts. The CLI creates the project folder.
+
+## Flags
+
+Every prompt has a flag. Options you leave out are asked interactively, unless you pass `--yes`.
+
+```bash
+# No prompts at all
+npx better-ts-stack my-api --framework nestjs --database prisma --auth --yes
+
+# Create the project in the current (empty) directory
+npx better-ts-stack . --framework nextjs --database drizzle --pm pnpm
+```
+
+| Flag                               | Values                                       |
+| ---------------------------------- | -------------------------------------------- |
+| `--framework <name>`               | `express`, `nestjs`, `nextjs`, `tanstack`    |
+| `--database <name>`                | `none`, `prisma`, `drizzle`, `mongoose`      |
+| `--pm <name>`                      | `npm`, `pnpm`, `bun`                         |
+| `--auth` / `--no-auth`             | Add authentication                           |
+| `--docker` / `--no-docker`         | Add Docker files                             |
+| `--rate-limit` / `--no-rate-limit` | Add rate limiting (Express and NestJS)       |
+| `--git` / `--no-git`               | Initialize a git repository                  |
+| `--install` / `--no-install`       | Install dependencies                         |
+| `-y`, `--yes`                      | Use defaults for missing options, no prompts |
+| `--dry-run`                        | List what would be created, write nothing    |
+| `-h`, `--help`                     | Show help                                    |
+| `-v`, `--version`                  | Show the version                             |
+
+`--database` names the ORM, which also selects the database: `prisma` and `drizzle` use PostgreSQL, `mongoose` uses MongoDB.
+
+With `--yes`, the defaults are Express, no database, no auth, no rate limiting, no Docker, git initialized, and dependencies not installed. The package manager defaults to the one that ran the CLI: `pnpm` for `pnpm dlx`, `bun` for `bunx`, and `npm` otherwise.
+
+The project path can be a name (`my-app`), a nested path (`apps/api`), or `.` for the current directory.
+
+## What It Can Scaffold
+
+| Project type   | Stack                                   | Optional setup                                                           |
+| -------------- | --------------------------------------- | ------------------------------------------------------------------------ |
+| Backend API    | Express 5 or NestJS 12 + TypeScript     | PostgreSQL, MongoDB, Prisma, Drizzle, Mongoose, JWT auth, Docker, git    |
+| Full-stack app | Next.js 16 or TanStack Start + React 19 | PostgreSQL, MongoDB, Prisma, Drizzle, Mongoose, Better Auth, Docker, git |
+
+Notes:
+
+- Better Auth is only offered for full-stack projects that use a database.
+
+## Interactive Prompt Flow
+
+Without flags, the CLI asks, in order:
+
+1. Project name or path
+2. Application type: `Backend API` or `Full-stack App`
+3. Framework
+   - Backend: `Express` or `NestJS`
+   - Full-stack: `Next.js` or `TanStack Start`
+4. Database: `none`, `PostgreSQL`, or `MongoDB`
+5. ORM/ODM when a database is selected
+   - PostgreSQL: `Prisma` or `Drizzle`
+   - MongoDB: `Mongoose`
+6. Package manager: `npm`, `pnpm`, or `bun`
+7. Docker setup
+8. Authentication
+   - Express and NestJS apps: JWT-based auth
+   - Next.js and TanStack Start apps: Better Auth, only when a database is selected
+9. Git initialization
+10. Dependency installation
+
+The CLI does not ask for a port. Backend projects default to `PORT=3000`.
+
+## What You Get
+
+Every generated project includes:
+
+- TypeScript with strict mode enabled
+- ESLint and Prettier pre-configured
+- `.env.example` and `.env` setup
+- Ready-to-run project scripts
+- Health check endpoint at `/health` for backend projects
+- shadcn-compatible UI components for Next.js and TanStack Start projects
+- Database wiring and schema setup when selected
+- Authentication scaffolding when selected
+- Docker files when selected
+- Optional git repository initialization
+
+## Requirements
+
+- Node.js 24 or later
+
+## Links
+
+- [Documentation](https://better-ts-stack.abdullahtech.me/docs)
+- [GitHub Repository](https://github.com/Abdullah-dev0/better-ts-stack)
+- [Issue Tracker](https://github.com/Abdullah-dev0/better-ts-stack/issues)
+
+## License
+
+MIT

package/dist/args.js

@@ -11,26 +11,28 @@ const FRAMEWORKS = [
 ].map((option) => option.value);
 const DATABASES = ["none", "prisma", "drizzle", "mongoose"];
 const PACKAGE_MANAGERS = types_1.packageManagerOptions.map((option) => option.value);
-exports.HELP_TEXT = `Usage: better-ts-stack [project-path] [options]
-
-Options left out are asked interactively, unless --yes is given.
-
-  --framework <name>      ${FRAMEWORKS.join(" | ")}
-  --database <name>       ${DATABASES.join(" | ")}
-  --pm <name>             ${PACKAGE_MANAGERS.join(" | ")}
-  --auth, --no-auth       Add authentication
-  --docker, --no-docker   Add Docker files
-  --git, --no-git         Initialize a git repository
-  --install, --no-install Install dependencies
-  -y, --yes               Use defaults for missing options and skip confirmation
-  --dry-run               List the files, dependencies, scripts, environment
-                          variables, and commands without writing anything
-  -h, --help              Show this help
-  -v, --version           Show the version
-
-Examples:
-  better-ts-stack my-api --framework nestjs --database prisma --auth --yes
-  better-ts-stack . --framework nextjs --database drizzle --pm pnpm
+exports.HELP_TEXT = `Usage: better-ts-stack [project-path] [options]
+
+Options left out are asked interactively, unless --yes is given.
+
+  --framework <name>      ${FRAMEWORKS.join(" | ")}
+  --database <name>       ${DATABASES.join(" | ")}
+  --pm <name>             ${PACKAGE_MANAGERS.join(" | ")}
+  --auth, --no-auth       Add authentication
+  --docker, --no-docker   Add Docker files
+  --rate-limit, --no-rate-limit
+                          Add rate limiting (Express and NestJS)
+  --git, --no-git         Initialize a git repository
+  --install, --no-install Install dependencies
+  -y, --yes               Use defaults for missing options and skip confirmation
+  --dry-run               List the files, dependencies, scripts, environment
+                          variables, and commands without writing anything
+  -h, --help              Show this help
+  -v, --version           Show the version
+
+Examples:
+  better-ts-stack my-api --framework nestjs --database prisma --auth --yes
+  better-ts-stack . --framework nextjs --database drizzle --pm pnpm
 `;
 function parseChoice(flag, value, allowed) {
     if (value === undefined)
@@ -53,6 +55,7 @@ function parseCliArgs(argv) {
                 pm: { type: "string" },
                 auth: { type: "boolean" },
                 docker: { type: "boolean" },
+                "rate-limit": { type: "boolean" },
                 git: { type: "boolean" },
                 install: { type: "boolean" },
                 yes: { type: "boolean", short: "y" },
@@ -75,6 +78,7 @@ function parseCliArgs(argv) {
         packageManager: parseChoice("pm", values.pm, PACKAGE_MANAGERS),
         useAuth: values.auth,
         useDocker: values.docker,
+        useRateLimit: values["rate-limit"],
         initGit: values.git,
         installDeps: values.install,
     };

package/dist/builder/buildPlanner.js

@@ -15,7 +15,7 @@ const gitInitializer_1 = require("./gitInitializer");
 const moduleSelector_1 = require("./moduleSelector");
 const templateContext_1 = require("./templateContext");
 // Files the builder writes itself instead of copying them from a module
-const GENERATED_FILES = ["package.json", ".env", ".env.example"];
+const GENERATED_FILES = ["package.json", ".env", ".env.example", "README.md"];
 // Loads the selected modules and merges their configurations
 async function loadBuildInputs(config) {
     const selection = (0, moduleSelector_1.selectModules)(config);

package/dist/builder/configGenerator.js

@@ -69,11 +69,7 @@ async function generatePackageJson(targetDir, mergedConfig, config) {
             name: config.projectName,
             version: "1.0.0",
             private: true,
-            // TanStack's srvx static serving needs Node 24.20+ on Windows (earlier
-            // 24.x reports mismatched file stats there, so every asset 404s)
-            engines: {
-                node: config.framework === "tanstack" ? ">=24.20.0" : ">=24.0.0",
-            },
+            engines: { node: ">=24.0.0" },
             description: `Project created with better-ts-stack using ${config.database !== "none" ? config.database : "no database"}`,
             ...(ESM_FRAMEWORKS.includes(config.framework) ? { type: "module" } : {}),
             ...(isFullstack ? {} : { main: BACKEND_ENTRY_FILES[config.framework] }),

package/dist/builder/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.planBuild = void 0;
 exports.build = build;
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const node_path_1 = __importDefault(require("node:path"));
 const nextSteps_1 = require("../output/nextSteps");
 const types_1 = require("../types");
 const validators_1 = require("../validators");
@@ -14,8 +15,17 @@ const configGenerator_1 = require("./configGenerator");
 const dependencyInstaller_1 = require("./dependencyInstaller");
 const fileProcessor_1 = require("./fileProcessor");
 const gitInitializer_1 = require("./gitInitializer");
+const readmeGenerator_1 = require("./readmeGenerator");
 var buildPlanner_2 = require("./buildPlanner");
 Object.defineProperty(exports, "planBuild", { enumerable: true, get: function () { return buildPlanner_2.planBuild; } });
+// Empties a directory except for the entries it may have had before the build
+async function removeCreatedEntries(dir) {
+    for (const entry of await fs_extra_1.default.readdir(dir)) {
+        if (!validators_1.PRESERVED_ENTRIES.includes(entry)) {
+            await fs_extra_1.default.remove(node_path_1.default.join(dir, entry));
+        }
+    }
+}
 // Main function to orchestrate the project construction process
 async function build(config, targetDir) {
     // 1. Validate target directory
@@ -42,8 +52,9 @@ async function build(config, targetDir) {
         if (config.packageManager === "pnpm") {
             await (0, configGenerator_1.generatePnpmWorkspace)(targetDir, mergedConfig.overrides);
         }
-        // 7. Generate environment files
+        // 7. Generate environment files and the README
         await (0, configGenerator_1.generateEnvFile)(targetDir, mergedConfig.envVars);
+        await (0, readmeGenerator_1.generateReadme)(targetDir, config, mergedConfig);
         // 8. Install dependencies and initialize git (both optional); a failure
         // in either is reported as a warning and does not fail the build
         const depsInstalled = config.installDeps &&
@@ -57,8 +68,9 @@ async function build(config, targetDir) {
     }
     catch (error) {
         // Remove the partial project so a retry is not blocked by a non-empty
-        // directory; a directory that already existed is emptied, not deleted
-        await (didDirectoryExist ? fs_extra_1.default.emptyDir(targetDir) : fs_extra_1.default.remove(targetDir)).catch(() => undefined);
+        // directory. A directory that already existed is emptied, not deleted,
+        // and keeps what it had before, such as .git
+        await (didDirectoryExist ? removeCreatedEntries(targetDir) : fs_extra_1.default.remove(targetDir)).catch(() => undefined);
         // Errors raised by the build steps already say what failed
         throw (0, types_1.isBuildError)(error)
             ? error

package/dist/builder/moduleSelector.js

@@ -9,13 +9,15 @@ function selectModules(config) {
         ? `backend/${framework}`
         : `frontend/${framework}`;
     const modules = [];
-    // Database and auth modules have one variant per framework (prisma/express,
-    // auth/nextjs, ...); the Docker module is shared
+    // Database, auth, and rate-limit modules have one variant per framework
+    // (prisma/express, auth/nextjs, ...); the Docker module is shared
     if (config.database !== "none")
         modules.push(`${config.database}/${framework}`);
     if (config.useDocker)
         modules.push("docker");
     if (config.useAuth)
         modules.push(`auth/${framework}`);
+    if (config.useRateLimit)
+        modules.push(`rate-limit/${framework}`);
     return { base, modules };
 }

package/dist/builder/readmeGenerator.js

@@ -0,0 +1,101 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderReadme = renderReadme;
+exports.generateReadme = generateReadme;
+// Writes the README.md of a generated project
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const node_path_1 = __importDefault(require("node:path"));
+const nextSteps_1 = require("../output/nextSteps");
+const types_1 = require("../types");
+const configGenerator_1 = require("./configGenerator");
+const DOCS_URL = "https://better-ts-stack.abdullahtech.me/docs";
+const FRAMEWORK_LABELS = {
+    express: "Express 5",
+    nestjs: "NestJS 12",
+    nextjs: "Next.js 16 (App Router)",
+    tanstack: "TanStack Start",
+};
+const DATABASE_LABELS = {
+    prisma: "Prisma with PostgreSQL",
+    drizzle: "Drizzle with PostgreSQL",
+    mongoose: "Mongoose with MongoDB",
+};
+// Renders rows as a Markdown table; pipes inside cells are escaped
+function table(headers, rows) {
+    const cell = (text) => text.replace(/\|/g, "\\|");
+    return [
+        `| ${headers.join(" | ")} |`,
+        `| ${headers.map(() => "---").join(" | ")} |`,
+        ...rows.map((row) => `| ${row.map(cell).join(" | ")} |`),
+    ];
+}
+// Builds the README content from the project's choices and merged config
+function renderReadme(config, mergedConfig, targetDir) {
+    const isFullstack = config.applicationType === "fullstack";
+    const lines = [
+        `# ${config.projectName}`,
+        "",
+        `Created with [better-ts-stack](${DOCS_URL}).`,
+        "",
+        "## Stack",
+        "",
+        `- **Framework:** ${FRAMEWORK_LABELS[config.framework]}`,
+    ];
+    if (config.database !== "none") {
+        lines.push(`- **Database:** ${DATABASE_LABELS[config.database]}`);
+    }
+    if (config.useAuth) {
+        lines.push(isFullstack
+            ? "- **Auth:** Better Auth with email and password"
+            : "- **Auth:** JWT with `/auth/register`, `/auth/login`, and `/auth/me`");
+    }
+    if (config.useDocker)
+        lines.push("- **Docker:** Dockerfile and Compose file");
+    lines.push(`- **Package manager:** ${config.packageManager}`, "");
+    const steps = (0, nextSteps_1.generateNextSteps)(config, targetDir, false, true);
+    lines.push("## Getting started", "", ...steps.map((step, index) => {
+        const isCommand = /^(npm|pnpm|bun|docker) /.test(step);
+        return `${index + 1}. ${isCommand ? `\`${step}\`` : step}`;
+    }), "");
+    // "pre" and "post" hooks run on their own, so only the commands to type
+    // are listed
+    const scripts = Object.entries(mergedConfig.scripts).filter(([name]) => !/^(pre|post)./.test(name));
+    if (scripts.length > 0) {
+        lines.push("## Scripts", "", ...table(["Command", "Runs"], scripts.map(([name, command]) => [
+            `\`${config.packageManager} run ${name}\``,
+            `\`${command}\``,
+        ])), "");
+    }
+    const envVars = Object.entries(mergedConfig.envVars);
+    if (envVars.length > 0) {
+        lines.push("## Environment variables", "", "`.env` holds your local values and is not committed. `.env.example` lists the same variables for other developers.", "", ...table(["Variable", "Default"], envVars.map(([key, value]) => [
+            `\`${key}\``,
+            configGenerator_1.GENERATED_SECRETS.includes(key)
+                ? "A random value generated in `.env`"
+                : `\`${value}\``,
+        ])), "");
+    }
+    lines.push("## Learn more", "", `- [${isFullstack ? "Full-stack" : "Backend"} guide](${DOCS_URL}/modules/${isFullstack ? "frontend" : "backend"})`);
+    if (config.database !== "none") {
+        lines.push(`- [Database guide](${DOCS_URL}/modules/database)`);
+    }
+    if (config.useAuth)
+        lines.push(`- [Auth guide](${DOCS_URL}/modules/auth)`);
+    if (config.useDocker) {
+        lines.push(`- [Docker guide](${DOCS_URL}/modules/docker)`);
+    }
+    lines.push(`- [Troubleshooting](${DOCS_URL}/troubleshooting)`, "");
+    return lines.join("\n");
+}
+// Writes README.md into the project
+async function generateReadme(targetDir, config, mergedConfig) {
+    try {
+        await fs_extra_1.default.writeFile(node_path_1.default.join(targetDir, "README.md"), renderReadme(config, mergedConfig, targetDir), "utf-8");
+    }
+    catch (error) {
+        throw (0, types_1.buildError)(error, "README_ERROR", "Failed to generate README.md");
+    }
+}

package/dist/builder/templateContext.js

@@ -3,6 +3,34 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildTemplateContext = buildTemplateContext;
 // Context builder for Handlebars, providing variables and helpers for templates
 const types_1 = require("../types");
+// The lockfile is optional: a project built before its first install has
+// none, so each install falls back to a plain install without it
+const DOCKER_COMMANDS = {
+    npm: {
+        setup: "",
+        manifests: "package.json package-lock.json*",
+        install: "if [ -f package-lock.json ]; then npm ci; else npm install; fi",
+        installProduction: "if [ -f package-lock.json ]; then npm ci --omit=dev; else npm install --omit=dev; fi",
+        cleanCache: "npm cache clean --force",
+        run: "npm run",
+    },
+    pnpm: {
+        setup: "RUN npm install -g pnpm@11",
+        manifests: "package.json pnpm-lock.yaml* pnpm-workspace.yaml",
+        install: "if [ -f pnpm-lock.yaml ]; then pnpm install --frozen-lockfile; else pnpm install; fi",
+        installProduction: "if [ -f pnpm-lock.yaml ]; then pnpm install --prod --frozen-lockfile; else pnpm install --prod; fi",
+        cleanCache: "pnpm store prune",
+        run: "pnpm run",
+    },
+    bun: {
+        setup: "COPY --from=oven/bun:1-alpine /usr/local/bin/bun /usr/local/bin/bun",
+        manifests: "package.json bun.lock*",
+        install: "if [ -f bun.lock ]; then bun install --frozen-lockfile; else bun install; fi",
+        installProduction: "if [ -f bun.lock ]; then bun install --production --frozen-lockfile; else bun install --production; fi",
+        cleanCache: "rm -rf /root/.bun/install/cache",
+        run: "bun run",
+    },
+};
 function buildTemplateContext(config) {
     return {
         projectName: config.projectName,
@@ -12,6 +40,8 @@ function buildTemplateContext(config) {
         port: types_1.DEFAULT_PORT,
         useDocker: config.useDocker,
         useAuth: config.useAuth,
+        useRateLimit: config.useRateLimit,
+        docker: DOCKER_COMMANDS[config.packageManager],
         helpers: {
             eq: (a, b) => a === b,
             runner: () => {

package/dist/index.js

@@ -32,7 +32,13 @@ async function main() {
     const directoryError = await (0, validators_1.validateDirectoryEmpty)(targetDir);
     if (directoryError)
         throw (0, types_1.buildError)(directoryError, "DIRECTORY_NOT_EMPTY");
-    const choices = await (0, prompts_1.collectStackChoices)(args.yes ? { ...types_1.DEFAULT_CHOICES, ...args.choices } : args.choices);
+    const choices = await (0, prompts_1.collectStackChoices)(args.yes
+        ? {
+            ...types_1.DEFAULT_CHOICES,
+            packageManager: (0, prompts_1.detectPackageManager)(),
+            ...args.choices,
+        }
+        : args.choices);
     const config = {
         projectName: node_path_1.default.basename(targetDir),
         applicationType: (0, types_1.getApplicationType)(choices.framework),

package/dist/output/nextSteps.js

@@ -7,23 +7,18 @@ exports.generateNextSteps = generateNextSteps;
 const node_path_1 = __importDefault(require("node:path"));
 const node_process_1 = require("node:process");
 const MONGODB_AUTH_SETUP_URL = "https://better-ts-stack.abdullahtech.me/docs/modules/database#mongoose-and-mongodb";
-// Node 24 releases before 24.20 report mismatched file stats on Windows, which
-// makes srvx (TanStack's production server) reject every static asset
-const MIN_TANSTACK_WINDOWS_NODE = [24, 20];
-function isNodeBelow([major, minor]) {
-    const [currentMajor, currentMinor] = process.versions.node
-        .split(".")
-        .map(Number);
-    return (currentMajor < major || (currentMajor === major && currentMinor < minor));
-}
-// Generates a list of instructions for the user to follow after project creation
-function generateNextSteps(config, targetDir, depsInstalled) {
+// Generates a list of instructions for the user to follow after project
+// creation. The README version leaves out the cd step, which only makes
+// sense in the terminal
+function generateNextSteps(config, targetDir, depsInstalled, isForReadme = false) {
     const steps = [];
     const isFullstack = config.applicationType === "fullstack";
     // Step 1: cd into project directory, unless it was created in place
+    // Quoted when it has spaces, so the command can be pasted as it is
     const relativeDir = node_path_1.default.relative((0, node_process_1.cwd)(), targetDir);
-    if (relativeDir)
-        steps.push(`cd ${relativeDir}`);
+    if (relativeDir && !isForReadme) {
+        steps.push(/\s/.test(relativeDir) ? `cd "${relativeDir}"` : `cd ${relativeDir}`);
+    }
     // Step 2: Set environment variables
     if (config.database !== "none") {
         steps.push("Review the generated .env and set your database connection details");
@@ -33,17 +28,15 @@ function generateNextSteps(config, targetDir, depsInstalled) {
             ? "Review BETTER_AUTH_SECRET and BETTER_AUTH_URL in .env"
             : "Review the generated JWT_SECRET in .env");
     }
-    if (config.framework === "tanstack" &&
-        process.platform === "win32" &&
-        isNodeBelow(MIN_TANSTACK_WINDOWS_NODE)) {
-        steps.push(`Upgrade Node.js to ${MIN_TANSTACK_WINDOWS_NODE.join(".")} or newer: on Windows, ` +
-            `Node ${process.versions.node} makes "npm start" return 404 for CSS, JS, and other static files`);
-    }
     // Step 3: Install dependencies if not already done
     if (!depsInstalled) {
         steps.push(`${config.packageManager} install`);
     }
-    // Step 4: Database-specific steps
+    // Step 4: Database-specific steps. With Docker, Compose runs the database
+    const hasDockerDatabase = config.useDocker && config.database !== "none";
+    if (hasDockerDatabase) {
+        steps.push("docker compose up -d db");
+    }
     if (config.database === "prisma") {
         steps.push(`${config.packageManager} run prisma:generate`);
         steps.push(`${config.packageManager} run prisma:migrate`);
@@ -53,9 +46,12 @@ function generateNextSteps(config, targetDir, depsInstalled) {
         steps.push(`${config.packageManager} run db:migrate`);
     }
     else if (config.database === "mongoose") {
-        steps.push("Ensure MongoDB is running locally or update MONGODB_URI in .env");
-        // Better Auth's MongoDB adapter uses transactions, which need a replica set
-        if (config.useAuth && isFullstack) {
+        if (!hasDockerDatabase) {
+            steps.push("Ensure MongoDB is running locally or update MONGODB_URI in .env");
+        }
+        // Better Auth's MongoDB adapter uses transactions, which need a replica
+        // set; the Compose database already runs as one
+        if (config.useAuth && isFullstack && !hasDockerDatabase) {
             steps.push("Better Auth uses MongoDB transactions: run MongoDB as a replica set (or use Atlas) " +
                 'and create the "user", "session", "account", and "verification" collections before signing up. ' +
                 `See ${MONGODB_AUTH_SETUP_URL}`);
@@ -68,5 +64,8 @@ function generateNextSteps(config, targetDir, depsInstalled) {
             ? "Visit /sign-up to create your first account"
             : "Create a user via POST /auth/register then login with /auth/login");
     }
+    if (config.useDocker) {
+        steps.push(`To run the app in Docker instead: ${config.packageManager} run docker:up`);
+    }
     return steps;
 }

package/dist/prompts/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.collectStackChoices = void 0;
+exports.detectPackageManager = exports.collectStackChoices = void 0;
 exports.collectProjectPath = collectProjectPath;
 exports.confirmBuild = confirmBuild;
 const types_1 = require("../types");
@@ -9,6 +9,7 @@ const validators_1 = require("../validators");
 const stack_1 = require("./stack");
 var stack_2 = require("./stack");
 Object.defineProperty(exports, "collectStackChoices", { enumerable: true, get: function () { return stack_2.collectStackChoices; } });
+Object.defineProperty(exports, "detectPackageManager", { enumerable: true, get: function () { return stack_2.detectPackageManager; } });
 // Returns the project path from the command line, or asks for it
 async function collectProjectPath(preset, isNonInteractive) {
     if (preset !== undefined) {