🚀 Nuxt 4 Boilerplate / Nuxt 4 starter

Kickstart Your Nuxt Project – Preconfigured, Optimized, Ready to Code, Easy config!

Ready-to-use framework for Nuxt projects, pre-configured framework with essential libraries and tools, streamlining development and ensuring a clean, structured codebase.

[--> Live Demo <--]

Features

• 🚀 Nuxt 4 - Powerful Vue.js framework with high performance
• 📐 Nuxt UI v3 - Fully styled and customizable components for Nuxt
• 🎨 TailwindCSS v4 - Utility-first CSS framework for rapid design
• 🌐 i18n - Multilingual support
  • English
  • Vietnamese
• 🔐 Next-auth - Built-in authentication system
• 📊 Pinia - Global state managemen
• 🛠 VueUse - Collection of Essential Vue Composition Utilities
• 🪄 ESLint - All-in-one ESLint integration for Nuxt
• 🧪 Testing - Vitest support for unit and integration tests, Playwright for e2e test.
• 🔍 SEO Friendly - Optimized for search engines

System Requirements

• Node.js 18.x or higher
• npm or yarn or pnpm (recommend)

Installation

# Clone repository
git clone https://github.com/heydayle/nuxt-boilerplate.git
cd nuxt-boilerplate

# Install dependencies
pnpm install

Usage

Development Environment

Duplicate example.env and rename to .env and run:

# Start development server
pnpm dev

Access the application at http://localhost:3000

Production Build

# Build for production
pnpm build

# Run the built application
pnpm start

Project Structure

nuxt-boilerplate-v3/
    ├── app/
    │    ├── assets/            # Static assets (images, fonts, etc.)
    │    ├── components/        # Reusable Vue components
    │    ├── composables/       # Vue composables
    │    ├── layouts/           # Page layouts
    │    ├── middleware/        # Nuxt middleware
    │    ├── pages/             # Application pages
    │    │      └── index.vue   # Homepage
    │    ├── plugins/           # Nuxt plugins
    │    ├── utils/             # Utility functions
    │    ├── app.config.ts      # App configuration
    │    └── app.vue            # App root
    ├── i18n/                   # i18n 
    │    └── locales/           # Language json
    ├── content/                # Nuxt Content files
    ├── public/                 # Public static files
    ├── server/                 # Server API endpoints and middleware
    ├── stores/                 # Pinia stores
    ├── .env                    # Environment variables
    ├── content.config.ts       # Nuxt Content configuration
    ├── nuxt.config.ts          # Nuxt configuration
    ├── README.md               
    └── tsconfig.json           # TypeScript configuration

Contributing

We welcome all contributions to improve this project!

How to Contribute

1. Fork this repository
2. Create a new branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Contribution Guidelines

• Ensure your code follows the project's naming conventions and formatting
• Add tests for any new features or bug fixes if possible
• Update documentation when necessary
• Describe your changes in detail in the Pull Request

License

This project is distributed under the MIT License. See the LICENSE file for more information.

Contact

• GitHub: heydayle
• Website: Thinh Le

---

Built with ❤️ by heydayle