Skip to content

Installation

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

Prerequisites

Before you begin, make sure you have the following installed:

  • Node.js 18+ Download Node.js
  • npm, yarn, or pnpm — npm ships with Node.js; yarn and pnpm are optional alternatives
  • Git — for cloning the repository

Step 1: Clone the Repository

git clone https://github.com/colorlib/apex-dashboard.git
cd apex-dashboard

Step 2: Install Dependencies

Use your preferred package manager:

npm

npm install

yarn

yarn

pnpm

pnpm install

Step 3: Run the Dev Server

npm run dev

The development server starts at http://localhost:3000. Next.js hot-reloads your changes automatically so you can see updates in real time.

Step 4: Build for Production

When you are ready to deploy, create an optimized production build:

npm run build
npm run start

npm run build compiles and optimizes the application. npm run start serves the built output on port 3000.

Available Scripts

CommandDescription
npm run devStart development server with hot reload
npm run buildCreate optimized production build
npm run startServe the production build
npm run lintRun ESLint across the project

Next Steps

Now that you have the project running, explore the Folder Structure to understand how the codebase is organized.