Skip to main content

Installation

Prerequisites​

  • Node.js >= 20.9.0
  • pnpm >= 10.6
  • PostgreSQL >= 16 (or Docker)

Create a New Project​

The fastest way to get started is with create-marketlum-app:

pnpm create marketlum-app my-market
cd my-market

This scaffolds a complete project with:

  • An API application (NestJS)
  • A web application (Next.js)
  • Pre-configured database migrations
  • Admin user seeder

Start the Database​

Using Docker:

pnpm db:up

Or configure PostgreSQL manually and update the .env file with your connection details.

Run Migrations​

pnpm migration:run

This creates all required database tables and indexes.

Seed the Admin User​

pnpm seed:admin

This creates the default admin user:

Start Development​

pnpm dev

The API starts on http://localhost:3001 and the web app on http://localhost:3000.

Log in at http://localhost:3000/login with the admin credentials above.