Documentation

SaleX Documentation

Everything you need to install, configure, and run your SaleX multi-vendor marketplace — written for beginners, with every command and click explained.

Next.js 16 React 19 PostgreSQL + Prisma Supabase or self-hosted Postgres Multi-vendor Multi-currency

Quick start in 5 steps

If you are comfortable with a terminal, this is the whole journey. Each step links to a detailed guide.

  1. Install the tools

    Install Node.js 20 or newer and PostgreSQL 14 or newer on your computer. See System Requirements.

  2. Unpack & install dependencies

    Extract the downloaded SaleX package, open the folder in a terminal, and install the project libraries. Full walkthroughs: Windows or macOS.

  3. Create your .env file

    Copy the example environment file and fill in your database URL and security keys. See Environment Configuration.

  4. Create the database & run the setup

    Run the provided setup commands to create all database tables and load the starting data, including the first administrator account. See Database & Storage.

  5. Start SaleX

    npm run dev

    Open http://localhost:3000 in your browser. The storefront loads, and the admin panel is at /admin. Then complete the First-Time Setup checklist.

    ✓ Success looks like: the SaleX homepage renders with products and a working navigation bar.

Package manager SaleX ships with both package-lock.json (npm) and pnpm-lock.yaml (pnpm). Use one package manager consistently — the guides below use npm, which every Node.js installation includes. If you prefer pnpm, replace npm run … with pnpm … and npm install with pnpm install.

Choose your path

Guides by role

How to use this documentation

Terms used in this documentation

TermPlain-English meaning
TerminalA text window where you type commands (PowerShell on Windows, Terminal on macOS).
DependencyA ready-made code library the project uses. Installed with one command, not by hand.
DatabaseWhere all information lives — products, orders, users. SaleX uses PostgreSQL (Supabase works out of the box).
MigrationA scripted change that creates or updates database tables. Run by a command.
Environment file (.env)A private settings file for your project — database address, passwords, API keys.
Admin panelThe back-office at /admin where the store owner manages everything.
VendorA seller with their own store inside your marketplace.
SeedStarter data loaded into the database (first admin account, demo content).