Getting Started

Prerequisites

• Node.js version 20.11 or higher.
• VSCode is recommended.
• PNPM is recommended.

Directory Structure

The Pergel contains a structure like the one below. This structure keeps your project clean in a clean code layout and facilitates communication between modules.

TIP

If you have discovered a better structure, please contact us. We are open to suggestions.

Twitter | Discord | GitHub

.config/
├─ pergel.ts

.nuxt/
...

pergel/
├─ .vscode/
│  ├─ settings.json
├─ [moduleName-projectName]/
│  ├─ ...
├─ .env.example
├─ projectName.docker-compose.yml
├─ merged-package.json
├─ README.json

server/
├─ [moduleName-projectName]/
│  ├─ ...

Installation

Nuxt installation guide is here.

CLI installation guide is here.

Nitro installation guide is here. (Not ready yet)