Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Codefied-CodePix/KaroCar-platform/llms.txt

Use this file to discover all available pages before exploring further.

KaroCar Platform is the unified monorepo that powers all KaroCar web properties. Built on Turborepo and pnpm workspaces, it orchestrates six Next.js applications alongside shared packages for UI components, ESLint configuration, and TypeScript settings — enabling teams to move fast with consistent tooling and a single source of truth.

Introduction

Learn what KaroCar Platform is, how it’s structured, and who it’s built for.

Quickstart

Clone the repo, install dependencies, and run the full platform in minutes.

Monorepo Structure

Understand the apps and packages layout, workspace conventions, and Turbo task graph.

Shared UI Library

Explore the @karo-car/ui component library shared across all applications.

Platform Applications

KaroCar Platform ships six purpose-built Next.js applications. Each is independently deployable and shares common packages through pnpm workspaces.

Web

Public-facing KaroCar website and marketing pages.

Admin

Internal admin dashboard for platform management.

Auth

Centralised authentication service for all apps.

Customer

Customer-facing portal for managing bookings and account.

Vendor

Vendor dashboard for managing listings and orders.

Corporate

Corporate portal for business accounts and fleet management.

Getting Started

1

Prerequisites

Ensure you have Node.js ≥ 18 and pnpm 9 installed on your machine.
2

Clone and install

Clone the repository and install all workspace dependencies with pnpm.
git clone https://github.com/Codefied-CodePix/KaroCar-platform.git
cd KaroCar-platform
pnpm install
3

Start development servers

Run all applications in development mode simultaneously using Turbo.
pnpm dev
4

Build for production

Build all apps and packages with full Turborepo caching and dependency ordering.
pnpm build
Use turbo dev --filter=<app> to start only a specific application — for example turbo dev --filter=web — if you don’t need the full platform running locally.

Build docs developers (and LLMs) love