Nuxt Installation

Prerequisites

• Node.js version 20.11 or higher.
• VSCode is recommended, along with the official Vue extension.
• PNPM is recommended.

Skip More Nuxt Configuration here.

Installation

pnpm

$ pnpm add -D pergel

npm

$ npm add -D pergel

yarn

$ yarn add -D pergel

bun

$ bun add -D pergel

Setup Wizard

Get started with Pergel by running the following command: This will create a pergel.ts file in your project .config folder.

pnpm

$ pnpm pergel init

npm

$ npm pergel init

yarn

$ yarn pergel init

bun

$ bun pergel init

Usage

1. Go to nuxt.config.ts and add the following code:

// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
  modules: [
    'pergel/nuxt',
  ],
})

2. The prepare command creates a .nuxt directory in your application and generates types.

pnpm

$ pnpm nuxt prepare

npm

$ npm nuxt prepare

yarn

$ yarn nuxt prepare

bun

$ bun nuxt prepare

3. Crete project with the following command:

// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
  modules: [
    'pergel/nuxt',
  ],
  pergel: {
    projects: {
      // changeName -> Please change this to your project name camelCase
      changeName: {
        // ...modules and options
      }
    }
  },
})

changeName

changeName is the name of your project. Please change it to your project name.

4. Generates types and pergel folder upgrade.

pnpm

$ pnpm nuxt prepare

npm

$ npm nuxt prepare

yarn

$ yarn nuxt prepare

bun

$ bun nuxt prepare

INFO

Success! You have installed Pergel. Now you can start your project with Pergel. More Nuxt Configuration here.