Koncepp Nuxt Layer

A comprehensive Nuxt.js layer that serves as a foundation for freelance projects. This layer includes essential configurations, components, and utilities to kickstart your Nuxt.js projects.

Features

• 📦 TypeScript support
• 🎯 Common components and utilities

Project Structure

├── components/    # Reusable Vue components
├── composables/   # Vue composables
├── utils/         # Utility functions
├── types/         # TypeScript type definitions
├── assets/        # Static assets
└── docs/          # Documentation

Usage

To use this layer in your Nuxt project, add it to your nuxt.config.ts:

export default defineNuxtConfig({
  extends: ['koncepp-nuxt-layer']
})

Working on the layer

The .playground directory should help you on trying your layer during development.

Running bun dev will prepare and boot .playground directory, which imports your layer itself.

Distributing your layer

Your Nuxt layer is shaped exactly the same as any other Nuxt project, except you can publish it on NPM.

To do so, you only have to check if files in package.json are valid, then run:

npm publish --access public

Once done, your users will only have to run:

npm install --save your-layer

Then add the dependency to their extends in nuxt.config:

defineNuxtConfig({
  extends: 'your-layer'
})

Development Server

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

pnpm dev

Production

Build the application for production:

pnpm build

Or statically generate it with:

pnpm generate

Locally preview production build:

pnpm preview

Checkout the deployment documentation for more information.

Contributing

Feel free to contribute to this project by submitting issues or pull requests.

License

MIT