Skip to content
AdmindekDocs

Installation

Step-by-step guide to getting Admindek running on your local machine.

Prerequisites

Make sure you have the following installed before you begin:

  • Node.js 18+ — Download from nodejs.org
  • pnpm 9+ — Recommended package manager — install with: npm install -g pnpm
  • Git — For version control

Step 1: Extract the Archive

Unzip the downloaded file and navigate into the project directory:

unzip admindek.zip && cd admindek

Step 2: Install Dependencies

Install all workspace dependencies from the monorepo root:

pnpm install

If you prefer npm or Yarn, you can use npm install or yarn install instead, though pnpm is recommended for workspace support.

Step 3: Start Development Server

Start the Next.js development server:

pnpm dev

This opens http://localhost:3000 in your browser. To target the Next.js package specifically within the monorepo, use:

pnpm --filter @admindek/nextjs dev

Step 4: Build for Production

Create an optimised production build, then preview it locally:

pnpm build
pnpm preview

Monorepo Structure

Admindek is a pnpm monorepo with three packages:

  • packages/theme — Shared SCSS design system consumed by all framework packages.
  • packages/html — Bootstrap-based HTML template version.
  • packages/nextjs — The Next.js app — imports the shared theme via @admindek/theme.

Next Steps