Documentation

System Requirements

Everything SaleX needs on your computer (for development) or server (for production). Check this list before installing.

On this page

For local development

RequirementMinimumNotes
Operating systemWindows 10/11 (64-bit) or macOS 12+Linux works identically to macOS in the terminal.
Node.jsv20 LTS or newer (v22 recommended)SaleX uses Next.js 16, which requires Node 20+. Download the “LTS” installer from nodejs.org.
npmIncluded with Node.jsCheck with npm -v. pnpm also works (a lockfile is included).
PostgreSQL14 or newerThe database engine. Install locally, or use a free hosted database (Supabase, Neon) — then skip the local install.
RAM4 GB (8 GB comfortable)The dev server compiles pages on the fly.
Disk space~2 GBDependencies plus uploads.
BrowserCurrent Chrome, Edge, Firefox, or SafariFor using the storefront and admin panel.
No PHP needed SaleX is not a PHP/WordPress script. It is a Node.js application — there is nothing to upload to cPanel shared PHP hosting. See Choosing hosting below.

Check your versions

Open a terminal (Windows: PowerShell; macOS: Terminal) and run each command. Success looks like a version number, not an error.

node -v    # should print v20.x.x or newer
npm -v     # should print a version like 10.x.x
psql --version   # PostgreSQL: should print 14 or newer (if installed locally)

For production

RequirementRecommendationNotes
ServerVPS / cloud VM, 2 vCPU, 4 GB RAM, Ubuntu 22.04+Any Linux server you can SSH into works.
Node.jsv20 LTS or newer (same as local)Production runs the built app with npm run start or a process manager.
PostgreSQLManaged service (Supabase, Neon, RDS) or on-serverManaged backups are strongly recommended.
Reverse proxyNginx or CaddyHandles HTTPS and forwards traffic to the app port (3000).
HTTPS certificateLet's Encrypt (free) via CertbotRequired for logins and payments.
Process managerpm2 or systemd serviceKeeps the app running and restarts it after crashes/reboots.

Choosing hosting

Hosting typeCompatible?Why
Shared PHP hosting (cPanel “PHP hosting”)Not compatibleCannot run Node.js applications or persist a Node process.
VPS (DigitalOcean, Hetzner, Vultr, Linode, Contabo…)YesFull control; documented in Server Deployment and DigitalOcean VPS Setup. PostgreSQL can run on the same server.
Node-friendly PaaS (Render, Railway, Fly.io)YesSet the start command and environment variables; managed Postgres available.
Managed Next.js (Vercel)Partially — needs reviewNext.js itself deploys, but SaleX writes uploaded media to the local storage/ folder, which is ephemeral on serverless platforms. Use an external storage/database strategy or a long-running server instead.
Static hosts (Netlify static, GitHub Pages)Not compatibleSaleX is a dynamic server application, not a static site.
Local uploads Product images are stored on the server disk (folder storage/) in the default configuration. On any host where the disk resets (some container platforms), uploaded files disappear on redeploy — back up this folder or use a host with persistent disk. See Database & Storage.