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.
AdonisJS v6 and Nuxt 4 require a modern version of Node.js.
Verify your Node.js installation:
node -v
# Should output v20.6.0 or higher
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
npm -v
npm install -g yarn
yarn -v
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 is required for running the development infrastructure. The kit uses Docker Compose to manage the following services:
| Service | Image | Port | Purpose |
|---|---|---|---|
| PostgreSQL | postgres:15-alpine | 5432 | Primary database |
| Redis | redis:latest | 6379 | Queue processing (BullMQ) |
| MailHog | mailhog/mailhog:latest | 1025, 8025 | Email testing |
| Stripe CLI | stripe/stripe-cli:latest | - | Webhook forwarding |
docker --version
# Should output Docker version 24.x.x or higher
docker compose version
# Should output Docker Compose version v2.x.x or higher
While you can use any code editor, we recommend Visual Studio Code with the following extensions for the best development experience:
| Resource | Minimum | Recommended |
|---|---|---|
| RAM | 8 GB | 16 GB |
| Disk Space | 5 GB | 10 GB |
| CPU | 2 cores | 4+ cores |