Tutorials · Getting started

Prepare your development environment

You need Node.js 24 or later, pnpm 11.7 or later and Git, and all commands run in a Unix-like terminal.

Windows users: install WSL first

Run this in PowerShell opened as administrator, restart when prompted, then open "Ubuntu". From then on, keep all tools, commands and app directories inside WSL. See Microsoft's WSL installation guide.

PowerShell
wsl --install

Install Node.js and pnpm

Install nvm by following nvm's instructions, then run:

Bash
nvm install 24

If you use fnm, install fnm by following fnm's instructions, then run:

Bash
fnm install 24

Then install pnpm:

Bash
npm install -g pnpm@11

Open a new terminal when you're done.

Install Git

On macOS, run git --version and follow the prompt to install the command line developer tools. On Linux and WSL, install it with the package manager, for example sudo apt install git. Then set your name and email:

Bash
git config --global user.name "Your Name"
git config --global user.email "you@example.com"

Done whennode --version shows v24 or later, pnpm --version shows 11.7 or later, and git config user.name shows your name.

NocoBase docs assistant

Ask anything about NocoBase…

Each question is answered independently, without earlier questions or answers. Include all relevant context.