Create Nuxt extendable layer with this GitHub template.
Make sure to install the dependencies:
bun install
Your theme 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 theme during development.
Running bun dev
will prepare and boot .playground
directory, which imports your theme 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 @repo/ui
Then add the dependency to their extends
in nuxt.config
:
defineNuxtConfig({
extends: '@repo/ui'
})
Start the development server on http://localhost:3000
bun dev
Build the application for production:
bun build
Or statically generate it with:
bun generate
Locally preview production build:
bun preview
Checkout the deployment documentation for more information.