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.

This quickstart walks you through everything you need to go from zero to a fully running local development environment for KaroCar Platform. By the end you’ll have all six Next.js applications — web, admin, auth, customer, vendor, and corporate — running concurrently via Turborepo’s task orchestration, and you’ll know how to build, lint, and target individual apps with filter flags.

​
Prerequisites

Before you begin, make sure the following are installed on your machine:
RequirementVersionNotes
Node.js>=18Specified in the root package.json engines field
pnpm9.0.0Specified as packageManager in the root package.json
The packageManager field in package.json is set to pnpm@9.0.0. If you have Corepack enabled (corepack enable), Node.js will automatically use the correct pnpm version without any manual installation step.
Install pnpm globally if you haven’t already: 
npm install -g pnpm@9.0.0

​
Setup Steps

1

Clone the repository

Clone KaroCar Platform from GitHub and navigate into the project root:
git clone https://github.com/Codefied-CodePix/KaroCar-platform.git
cd KaroCar-platform
The repository is a private monorepo — ensure you have access and that your Git credentials are configured before cloning.
2

Install dependencies

Run a single pnpm install from the repository root. Because pnpm-workspace.yaml declares both apps/* and packages/* as workspace members, pnpm resolves and installs the dependencies for all six apps and all shared packages in one pass, hard-linking shared modules to save disk space:
pnpm install
You should see pnpm hoist shared dependencies and link internal packages (like @karo-car/ui) directly from the packages/ui source directory — no publishing required.
Never run npm install or yarn in individual app directories. Always install from the repo root so that pnpm’s workspace linking is preserved and lockfile integrity is maintained.
3

Start the development servers

Start all six Next.js applications simultaneously. The root dev script delegates to turbo run dev, which fans out the task to every workspace package in parallel:
pnpm dev
Turborepo streams the combined output of all apps to your terminal, prefixed by the app name so you can distinguish logs at a glance. Each Next.js app starts on its own port (Next.js auto-increments from 3000 when ports are already in use).
Want to start only one app? Use Turborepo’s --filter flag to target a specific workspace by its package name:
# Start only the public website
turbo dev --filter=web

# Start only the admin dashboard
turbo dev --filter=admin

# Start the auth service and anything that depends on it
turbo dev --filter=auth...
Valid filter values match the name field in each app’s package.json: web, admin, auth, customer, vendor, corporate.
4

Build for production

Compile all apps and packages for production. The root build script runs turbo run build, which respects the dependsOn: ["^build"] task definition — shared packages are always compiled before the apps that import them:
pnpm build
Build artifacts for each Next.js app are written to the app’s .next/ directory, as declared in the outputs field of turbo.json.To build a single app and its upstream package dependencies only:
pnpm exec turbo build --filter=web
Turborepo’s local cache is enabled by default. After your first full build, re-running pnpm build on an unchanged codebase will restore every task’s output from cache in milliseconds — you’ll see FULL TURBO in the terminal output. Only the tasks affected by your changes are re-executed, making iterative builds dramatically faster.

​
Other Root Scripts

The root package.json exposes several other useful scripts you can run from the repo root at any time:
ScriptCommandWhat it does
pnpm lintturbo run lintRuns ESLint across all apps and packages
pnpm formatprettier --write "**/*.{ts,tsx,md}"Auto-formats all TypeScript and Markdown files
pnpm check-typesturbo run check-typesRuns tsc --noEmit across all workspaces

​
What’s Next?

Monorepo Structure

Understand the directory layout, pnpm workspace globs, and how Turborepo’s task graph coordinates builds.

Local Setup

Environment variables, editor configuration, and tips for a smooth day-to-day development experience.

Build docs developers (and LLMs) love

Get started for freeTalk to us