MarketPlace — Fullstack (Client + API)

A multi-vendor e-commerce platform: Next.js frontend and NestJS backend (TypeORM + PostgreSQL)

📋 Table of Contents

• Features
• Tech Stack
• Getting Started
  • Prerequisites
  • Installation
  • Environment Variables
  • Database Setup
  • Running the App
• Project Structure
• API Documentation
• Testing
• Deployment
• Contributing
• License

✨ Features

🔐 Authentication & Authorization

- 🔒 JWT-based authentication with refresh tokens - 👥 Role-based access control (Admin, Seller, Customer) - ✉️ Email verification and password reset flow - 🌐 Social login integration (Google, Facebook)

🛍️ E-commerce Core

- 🏬 Multi-vendor marketplace support - 📚 Comprehensive product catalog with categories and attributes - 🔄 Advanced product variations and options - 📦 Inventory and stock management - ⭐ Product reviews and ratings system

🏪 Seller Features

- 👔 Complete seller profile management - 🏬 Multi-shop support per seller - 🎨 Custom storefront configuration - 📊 Sales analytics and reporting - 📦 Order management and fulfillment - 🔄 Refund and return processing

🛒 Shopping Experience

- 🛍️ Shopping cart with guest checkout - 💝 Wishlist functionality - 🏷️ Coupon and discount system - 🔍 Product search and filtering - 🔄 Related products and recommendations

💳 Payments

- 💳 Secure payment processing with Stripe

MarketPlace — Fullstack (Client + API)

A multi-vendor e-commerce platform: a Next.js frontend and a NestJS backend (TypeORM + PostgreSQL)

Table of Contents

• Overview
• Tech Stack
• Quick Start
  • Prerequisites
  • Run the Server (API)
  • Run the Client (Frontend)
  • Run Both Locally
• Project Structure
• Environment variables
• Testing & Linting
• Resources

Overview

This repository contains two top-level apps:

• client/ — a Next.js (App Router) React frontend using TypeScript and Tailwind.
• server/ — a NestJS backend API built with TypeScript, TypeORM, and PostgreSQL.

They can be run independently or together for local development. Below are quick, copy-ready steps to get both running.

Tech Stack

• Frontend: Next.js, React, TypeScript, Tailwind CSS
• Backend: NestJS, TypeScript, TypeORM, PostgreSQL, Redis (optional)
• Dev tools: PNPM, Docker, Jest, ESLint, Prettier

Quick Start

Prerequisites

• Node.js v18+
• PNPM
• PostgreSQL
• Redis (optional, used by the server)
• Docker & Docker Compose (optional)

Run the Server (API)

1. Open a terminal and change to the server/ directory:

cd server
pnpm install

2. Create environment file and configure DB credentials (copy from example if present):

cp .env.example .env
# then edit .env to set database, redis, and other secrets

3. Start the server in development mode (default port 3000):

pnpm run start:dev

The API should be reachable at http://localhost:3000. The server console will also print the Swagger/OpenAPI URL when available.

Run the Client (Frontend)

1. Open a new terminal and change to the client/ directory:

cd client
pnpm install

2. Configure the client to talk to the API. Create .env.local in client/ and set the API base URL (example):

# in client/.env.local
NEXT_PUBLIC_API_URL=http://localhost:3000

3. Start the Next.js dev server. To avoid port conflicts with the backend, run the frontend on port 3001:

PORT=3001 pnpm run dev

The web app will be available at http://localhost:3001.

Run Both Locally

Start the server (port 3000) then the client (port 3001). If you prefer Docker, consult any docker-compose.yml in the repo (top-level or inside server/) to start required services (Postgres, Redis) and the apps.

Project Structure

• client/ — Next.js frontend (App Router, TypeScript, Tailwind)

  • app/ — Next.js app folder
  • components/ — React components and UI primitives
  • public/ — static assets
  • package.json — frontend scripts & deps

• server/ — NestJS backend

  • src/ — Nest application source
  • src/modules — feature modules
  • package.json — backend scripts & deps
  • README.md — server-specific instructions (if present)

Environment variables

• server/.env — database, redis, JWT secrets, third-party API keys. Copy from server/.env.example when present.
• client/.env.local — frontend-specific variables (e.g. NEXT_PUBLIC_API_URL).

Ports used by default:

• Server API: 3000
• Client (Next.js): 3001 (recommended when running alongside server)

Testing & Linting

• Backend tests (in server/) typically run with:

cd server
pnpm test

• Frontend tests (in client/) run with:

cd client
pnpm test

Run linters and formatters with pnpm lint / pnpm format inside each project if scripts are defined.

Resources

• NestJS: https://docs.nestjs.com/
• Next.js: https://nextjs.org/docs
• TypeORM: https://typeorm.io/
• PostgreSQL: https://www.postgresql.org/docs/

---

If you'd like, I can also:

• Add example docker-compose.yml to orchestrate Postgres + Redis + both apps locally.
• Add a root-level Makefile or task scripts to start both projects with a single command.
• Commit this README update for you.