https://github.com/heydayle/nuxt4-boilerplate
Nuxt 4 starter - clean, fast, and scalable by Vite + Tailwind CSS + Nuxt UI + ESLint + Prettier + Testing (Vitest + Playwright) — everything you need to kickstart a modern Nuxt project 🚀
https://github.com/heydayle/nuxt4-boilerplate
nuxt nuxt3-template nuxt4 nuxt4-starter taiwindcss vue
Last synced: 2 months ago
JSON representation
Nuxt 4 starter - clean, fast, and scalable by Vite + Tailwind CSS + Nuxt UI + ESLint + Prettier + Testing (Vitest + Playwright) — everything you need to kickstart a modern Nuxt project 🚀
- Host: GitHub
- URL: https://github.com/heydayle/nuxt4-boilerplate
- Owner: heydayle
- License: mit
- Created: 2025-02-27T17:00:56.000Z (8 months ago)
- Default Branch: template
- Last Pushed: 2025-07-31T02:23:45.000Z (2 months ago)
- Last Synced: 2025-07-31T05:28:54.557Z (2 months ago)
- Topics: nuxt, nuxt3-template, nuxt4, nuxt4-starter, taiwindcss, vue
- Language: Vue
- Homepage: https://nuxt-boilerplate-starter.vercel.app
- Size: 3.47 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# 🚀 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](https://nuxt-boilerplate-template.vercel.app/) <--]
## Features
- [x] 🚀 **[Nuxt 4](https://nuxt.com)** - Powerful Vue.js framework with high performance
- [x] 📐 **[Nuxt UI v3](https://ui.nuxt.com/getting-started)** - Fully styled and customizable components for Nuxt
- [x] 🎨 **[TailwindCSS v4](https://tailwindcss.com/)** - Utility-first CSS framework for rapid design
- [x] 🌐 **[i18n](https://i18n.nuxtjs.org/)** - Multilingual support
- [x] English
- [x] Vietnamese
- [x] 🔐 **[Next-auth](https://authjs.dev/)** - Built-in authentication system
- [x] 📊 **[Pinia](https://pinia.vuejs.org/)** - Global state managemen
- [x] 🛠 **[VueUse](https://vueuse.org/)** - Collection of Essential Vue Composition Utilities
- [x] 🪄 **ESLint** - All-in-one ESLint integration for Nuxt
- [x] 🧪 **Testing** - [Vitest](https://vitest.dev/) support for unit and integration tests, [Playwright](https://playwright.dev/) for e2e test.
- [x] 🔍 **SEO Friendly** - Optimized for search engines
## System Requirements
- Node.js 18.x or higher
- npm or yarn or pnpm (recommend)
## Installation
```bash
# 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:
```bash
# Start development server
pnpm dev
```
Access the application at `http://localhost:3000`
### Production Build
```bash
# Build for production
pnpm build
# Run the built application
pnpm start
```
## Project Structure
```bash
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](https://github.com/heydayle)
- Website: [Thinh Le](https://thinh.io.vn)
---
Built with ❤️ by [heydayle](https://github.com/heydayle)