Documentation

Documentation

Welcome to the Pills of Zen Admin Theme documentation. Here you’ll find everything you need to get started with our admin theme.

Installation

To install the Pills of Zen Admin Theme on your local machine:

Prerequisites

Before you begin, ensure you have the following installed on your system:

  • Node.js (version 18 or higher)
  • Yarn
  • Git

Installation Steps

1. Clone the Repository 

git clone <repository-url>
cd wmiadmintheme2025

2. Install Dependencies 

yarn install

3. Development

To start the development server:

yarn dev

The application will be available at http://localhost:3000 by default.

4. Building for Production

To create a production build:

yarn build

The build files will be generated in the dist directory.

5. Preview Production Build

To preview the production build locally:

yarn preview

Available Scripts

  • yarn dev - Start development server
  • yarn build - Create production build
  • yarn preview - Preview production build
  • yarn lint - Run ESLint
  • yarn format - Format code using Prettier
  • yarn format:check - Check code formatting

Project Structure

  • /src - Source code directory
  • /public - Static assets
  • /dist - Production build output
  • /app - Application components and pages
  • /styles - Global styles and Tailwind configuration
  • /lib - Utility functions and shared code

Dependencies

The project uses several key dependencies:

  • React 19
  • Vite
  • TypeScript
  • Tailwind CSS
  • Radix UI components
  • React Router
  • React Hook Form
  • Zod for validation
  • Various libraries for data visualization (ApexCharts, Recharts) and calendar functionality (FullCalendar with dayGrid, timeGrid, interaction plugins)

Basic Usage

Learn how to use the basic features of Pills of Zen Admin Theme:

  1. Setup your project
  2. Configure theme options
  3. Customize components
  4. Deploy your application

Next Steps