Skip to content

pooya-hajjar/nuxt-starter-pack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 

Repository files navigation

Nuxt.js Starter Pack

Welcome to the Nuxt.js Starter Pack! This repository is designed to give you a head start on your Nuxt.js projects by providing a set of pre-installed modules,configurations, components, and utilities.

Features

This starter pack includes:

  • Nuxt.js: A powerful framework for building server-side rendered applications, static websites, and more.
  • High-Level Components: A collection of thoroughly tested and debugged high-level customizable components (try features of u-text-input, u-btn, u-dialog for testing).
  • Pinia: A lightweight and intuitive state management library for Vue.js.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development, with dynamic class support.
  • Nuxt Image: An optimized image handling module for Nuxt.js.
  • i18n: Internationalization support for multi-language applications.

Project Structure

  • .env File: Configuration file for environment variables. Ensure to create your own .env file based on the provided template.
  • Tailwind Dynamic Classes: Easily customizable utility classes with a colors.txt file for quick and dynamic color reference.
  • Components: A collection of reusable Vue.js components to speed up your development process.
  • Composables: A set of custom composable functions to handle common logic and functionality across your application.
  • Utils Functions: Utility functions that provide common, reusable logic across your project.

Customization

Tailwind CSS

To customize Tailwind CSS, modify the tailwind.config.ts file. The colors.txt file provides a handy reference for dynamic class creation.

Nuxt Modules

Feel free to add or remove Nuxt modules based on your project's needs. Update the nuxt.config.ts file to adjust your module configurations.

Components & Composables

Add your custom components to the components/ directory and composables to the composables/ directory. This structure helps maintain a clean and organized project.

USAGE

install the pack globally

npm i create-nuxt-starter-pack -g

run the script

npx create-nuxt-starter [project-name]

TODO

  • Add a CLI tool to make setup and customization easier.
  • Enhance and expand the starter pack features.