Getting Started

Prerequisites

Everything you need installed before you start building with Nuda Kit.

Before diving into the setup, ensure your development environment meets the following requirements. Nuda Kit relies on modern web standards (ESM, TypeScript 5) and containerization to provide a stable development experience.

Node.js

AdonisJS v6 and Nuxt 4 require a modern version of Node.js.

Required
Node.js v20.6.0 or later
AdonisJS v6 requires Node.js 20.6+ for native ESM and TypeScript support.
Recommended
Node.js v22 LTS
We recommend using the latest Active LTS version for best performance and security.

Verify your Node.js installation:

node -v
# Should output v20.6.0 or higher
If you need to manage multiple Node versions, we recommend using Volta or nvm.

Package Manager

You can use npm, yarn, or pnpm. We recommend pnpm for its speed and efficient disk space usage, especially with the separated frontend/backend structure.

npm install -g pnpm
pnpm -v

Git

Git is required for cloning the repository and version control.

git --version
# Should output git version 2.x.x or higher

If you don't have Git installed, download it from the official website.

Docker

Docker is required for running the development infrastructure. The kit uses Docker Compose to manage the following services:

ServiceImagePortPurpose
PostgreSQLpostgres:15-alpine5432Primary database
Redisredis:latest6379Queue processing (BullMQ)
MailHogmailhog/mailhog:latest1025, 8025Email testing
Stripe CLIstripe/stripe-cli:latest-Webhook forwarding

Installation

  1. Download and install Docker Desktop for your operating system.
  2. Verify the installation:
docker --version
# Should output Docker version 24.x.x or higher

docker compose version
# Should output Docker Compose version v2.x.x or higher
Docker Desktop includes Docker Compose v2. Make sure Docker Desktop is running before starting the development environment.

Optional: Code Editor

While you can use any code editor, we recommend Visual Studio Code with the following extensions for the best development experience:

System Requirements

ResourceMinimumRecommended
RAM8 GB16 GB
Disk Space5 GB10 GB
CPU2 cores4+ cores
Once you have all the prerequisites installed, you're ready to proceed with the Quick Setup or Manual Setup.