@eo/nuxt-ui

This module installs Tailwind, various composables and components (that match the EO design system) into your Nuxt application. Use it to quickly create a stunning UI.

Requirements

• Nuxt - 3.7.4 or newer

Setup

1. Add @eo/nuxt-ui dependency to your project

With pnpm

  pnpm add -D @eo/nuxt-ui

or, with npm

  npm install -D @eo/nuxt-ui

2. Add @eo/nuxt-ui to the modules array of nuxt.config.ts

export default {
    modules: [
        '@eo/nuxt-ui', {
            /* optional module configuration */
        })
],
}

Development

1. Clone this repository git clone [email protected]:evangelischeomroep/nuxt-ui-module.git
2. Run pnpm install

View components in Histoire

1. Run pnpm story:dev

View module in a Nuxt3 playground

1. Run pnpm playground:dev

View module in a Nuxt3 project

1. Use pnpm link --global inside the nuxt-ui-module repository to create a symbolic link.
2. Use pnpm prepack inside the nuxt-ui-module repository to create a build folder.
3. Go to any Nuxt 3 project and use the symbolic link by running pnpm link --global @eo/nuxt-ui

Make sure that both project folders are useing the same pnpm and node version

Release package

Use pnpm release to deploy. Don't use pnpm publish as this would break things as a pre-script is creating local symlinks