MUGNAVO.md

This project was scaffolded with create-mugnavo.

npm create mugnavo

• React 19 + React Compiler
• TanStack Start + Router + Query
• Tailwind CSS + shadcn/ui + Base UI (base-maia) + Remix Icon
• Vite 8 + Nitro v3
• Drizzle ORM + PostgreSQL
• Better Auth
• Oxlint + Oxfmt

Tip

This template is also available as a monorepo, powered by Vite+ and npm. See mugnavo/tanstarter-plus.

Getting Started

1. Use this template or create a project using our CLI:

   npm create mugnavo

2. Create a .env file based on .env.example.

3. Push the schema to your database with drizzle-kit:

   npm db push

   https://orm.drizzle.team/docs/migrations

4. Run the development server:

   npm dev

   The development server should now be running at http://localhost:3000.

Deploying to production

The vite config is currently configured to use Nitro to deploy on Netlify, but supports many other deployment presets like Vercel and Node.

While Nitro provides a great multi-provider default, the official @netlify/vite-plugin-tanstack-start is also available for Netlify deployments.

Refer to the TanStack Start hosting docs for deploying to other platforms.

Issue watchlist

• Router/Start issues - TanStack Start is in RC.
• Devtools releases - TanStack Devtools is in alpha and may still have breaking changes.
• Nitro v3 beta - The template is configured with Nitro v3 beta by default.

Goodies

Git hooks

We use Husky to run git hooks with the following tools:

• lint-staged - Run Oxfmt to format staged files on commit (pre-commit).

Scripts

We use npm package manager.

• auth:generate - Regenerate the auth db schema if you've made changes to your Better Auth config.
• db - Run drizzle-kit commands. (e.g. npm db generate, npm db studio)
• ui - The shadcn/ui CLI. (e.g. npm ui add button)
• format, lint - Run Oxfmt and Oxlint, or both via npm check.
• deps - Selectively upgrade dependencies via taze.

Utilities

• auth/middleware.ts - Sample middleware for forcing authentication on server functions. (see #5 and #17)
• theme-toggle.tsx, theme-provider.tsx - A theme toggle and provider for toggling between light and dark mode. (#7)