Skip to content

ersankarimi/nuxt3-ui-starter

Repository files navigation

Nuxt3 UI Starter

This project is generated using the official Nuxt UI Starter and has been enhanced with additional dependencies and configurations. It serves as a minimal starting point for building applications with Nuxt 3.

For further details, refer to the Nuxt documentation.

Features

  • Built with Nuxt 3
  • Integrates @nuxt/ui, @pinia/nuxt, and @sidebase/nuxt-auth modules
  • Includes ESLint for linting and code formatting
  • Full TypeScript support with type checking via vue-tsc

Setup

Make sure to install the dependencies:

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install

Development Server

Start the development server at http://localhost:3000:

# npm
npm run dev

# pnpm
pnpm dev

# yarn
yarn dev

# bun
bun run dev

Production

Build the application for production:

# npm
npm run build

# pnpm
pnpm build

# yarn
yarn build

# bun
bun run build

Preview the production build locally:

# npm
npm run preview

# pnpm
pnpm preview

# yarn
yarn preview

# bun
bun run preview

For more information, please refer to the deployment documentation.

Additional Scripts

This project includes several useful scripts:

  • Linting: pnpm lint (runs ESLint for code linting)
  • Code Formatting: pnpm format (fixes code format using ESLint)
  • Type Checking: pnpm typecheck (runs type checking with vue-tsc and nuxi)

License

This project is open source and available under the MIT License.