SaleX Documentation
Everything you need to install, configure, and run your SaleX multi-vendor marketplace — written for beginners, with every command and click explained.
Quick start in 5 steps
If you are comfortable with a terminal, this is the whole journey. Each step links to a detailed guide.
-
Install the tools
Install Node.js 20 or newer and PostgreSQL 14 or newer on your computer. See System Requirements.
-
Unpack & install dependencies
Extract the downloaded SaleX package, open the folder in a terminal, and install the project libraries. Full walkthroughs: Windows or macOS.
-
Create your
.envfileCopy the example environment file and fill in your database URL and security keys. See Environment Configuration.
-
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.
-
Start SaleX
npm run devOpen
http://localhost:3000in 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-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
Install on Windows
Step-by-step local setup for Windows 10/11, from Node.js to a running storefront.
Start → 🍎Install on macOS
Step-by-step local setup for Apple Mac, including Homebrew and Postgres.
Start → 🚀Deploy to a server
Take SaleX live on a VPS: build, run, reverse proxy, domain and HTTPS.
Deploy → 🌊DigitalOcean VPS
Create a Droplet and run SaleX with its own PostgreSQL — no Supabase needed.
Set up → 📱Mobile app
Connect the Flutter app to your server, set up Firebase, and build for Android and iOS.
Set up → 🛠️Fix a problem
Organized solutions for the errors buyers hit most often.
Troubleshoot →Guides by role
Administrator
Store configuration, products, orders, vendors, payments, shipping and reports.
Open guide → 🏪Vendor
Vendor registration, store setup, product management, inventory and orders.
Open guide → 🛍️Customer
Browsing, search, cart, checkout, orders and account management.
Open guide →How to use this documentation
- Blue callout boxes like this one give context and clarifications.
- Green “Tip” boxes save you time; yellow “Warning” boxes prevent mistakes; red “Danger” boxes prevent data loss.
- Every terminal command has a Copy button — click it, then paste into your terminal.
- The search field in the top bar searches all documentation pages at once.
- Long pages include a “On this page” table of contents at the top.
Terms used in this documentation
| Term | Plain-English meaning |
|---|---|
| Terminal | A text window where you type commands (PowerShell on Windows, Terminal on macOS). |
| Dependency | A ready-made code library the project uses. Installed with one command, not by hand. |
| Database | Where all information lives — products, orders, users. SaleX uses PostgreSQL (Supabase works out of the box). |
| Migration | A 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 panel | The back-office at /admin where the store owner manages everything. |
| Vendor | A seller with their own store inside your marketplace. |
| Seed | Starter data loaded into the database (first admin account, demo content). |