Skip to content

Quick Start

Choose your preferred framework version to quickly start HaloLight.

Requirements

  • Node.js 18.17 or higher
  • pnpm 8+ (recommended) / npm / yarn

Next.js Version

bash
# Clone repository
git clone https://github.com/halolight/halolight.git
cd halolight

# Install dependencies
pnpm install

# Start development server
pnpm dev

Visit http://localhost:3000 to see the result.

Detailed documentation: Next.js Version Guide

Vue Version

bash
# Clone repository
git clone https://github.com/halolight/halolight-vue.git
cd halolight-vue

# Install dependencies
pnpm install

# Start development server
pnpm dev

Visit http://localhost:5173 to see the result.

Detailed documentation: Vue Version Guide

Default Credentials

All versions use the same Mock credentials:

RoleEmailPassword
Adminadmin@halolight.h7ml.cn123456

Directory Structure

project-root/
├── src/
│   ├── app/              # Page routes
│   ├── components/       # Components
│   │   ├── ui/          # shadcn/ui components
│   │   ├── layout/      # Layout components
│   │   └── dashboard/   # Dashboard components
│   ├── hooks/           # Custom hooks
│   ├── stores/          # State management
│   ├── services/        # API services
│   ├── lib/             # Utility library
│   ├── types/           # Type definitions
│   └── mocks/           # Mock data
├── public/              # Static assets
└── package.json

Next Steps