A powerful Nuxt 3 boilerplate with an array of useful features.
This boilerplate is designed to expedite Nuxt 3 projects by integrating essential technologies and libraries. It's configured with the following features:
- Nuxt 3 as the foundation
- Vue 3 for efficient UI rendering
- TypeScript for scalable and typed code
- TailwindCSS for versatile styling
- Naive UI for UI components
- PWA support for progressive web applications
- Nuxt 3 Modules:
- Device detection with @nuxtjs/device
- ESLint configuration with @nuxtjs/eslint and @nuxtjs/eslint-config-typescript
- Google Fonts integration with @nuxtjs/google-fonts
- TailwindCSS setup using @nuxtjs/tailwindcss
- State persistence with @pinia-plugin-persistedstate/nuxt
- Headless Ui Components with nuxt-headlessui
- Iconify icons via nuxt-icon
- CSS optimization using nuxt-purgecss
- shadcn-nuxt for more flexible ui components
- Development Tools:
- ESLint for code quality
- TypeScript for typed JavaScript
- Vue for reactive components
- Dependencies:
- @pinia/nuxt for state management
- @vueuse/core and @vueuse/nuxt for Vue composition utilities
- pinia for state management
To get started with this boilerplate, ensure you have Node.js and npm installed. Then, follow these steps:
- Clone the repository:
git clone https://github.com/muneebbug/nuxt3-awesome-boilerplate.git
- Navigate to the project directory:
cd nuxt3-awesome-boilerplate
- Navigate to the project directory:
yarn install
- To run the project in development mode:
yarn dev
- Building for Production:
yarn build
- Linting:
yarn lint
- Fix linting issues:
yarn lint:fix
Contributions are welcome! If you encounter any bugs or have suggestions for improvements, feel free to create an issue or submit a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.