Create Nuxt extendable layer with this GitHub template.
Make sure to install the dependencies:
pnpm install
Your layer is at the root of this repository, it is exactly like a regular Nuxt project, except you can publish it on NPM.
The .playground
directory should help you on trying your layer during development.
Running pnpm dev
will prepare and boot .playground
directory, which imports your layer itself.
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'
})
Start the development server on http://localhost:3000
pnpm dev
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.