Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/yoelrrg-code/pcconnect/llms.txt

Use this file to discover all available pages before exploring further.

This page walks you through every step needed to get PC Connect running on your local machine — from cloning the repository to opening the live-reloading dev server in your browser. The stack is React 19 + TypeScript + Vite 8, so the setup is fast and the feedback loop is immediate.

Prerequisites

Before you begin, make sure the following tools are available in your environment:
RequirementMinimum VersionNotes
Node.js18+LTS recommended
Package managernpm 9 / yarn 1.22 / pnpm 8Any of the three works
GitAny recent versionFor cloning the repository

Installation Steps

1

Clone the repository

Run the following command to clone PC Connect and move into the project directory:
git clone https://github.com/yoelrrg-code/pcconnect.git && cd pcconnect
2

Install dependencies

Install all production and development dependencies declared in package.json:
npm install
Key dependencies installed include react@^19.2.6, @mui/material@^9.1.2, apexcharts@^5.15.1, lucide-react@^1.21.0, and dayjs@^1.11.21.
3

Start the development server

Launch the Vite development server:
npm run dev
Vite will compile the project and print a local URL to the terminal. The output typically looks like:
VITE v8.x.x  ready in ~300ms

➜  Local:   http://localhost:5173/
➜  Network: http://192.168.x.x:5173/
4

Open the application in your browser

Navigate to http://localhost:5173. You will be presented with the PC Connect login screen. Use the demo credentials documented in Authentication to sign in.

Available Scripts

All scripts are defined in package.json under the "scripts" key:
ScriptCommandDescription
devviteStarts the Vite HMR development server
buildtsc -b && vite buildType-checks with TypeScript then bundles for production
linteslint .Runs ESLint across the entire codebase
previewvite previewServes the production build locally for inspection
# Type-check and build for production
npm run build

# Preview the production bundle
npm run preview

# Lint all TypeScript and TSX files
npm run lint

Vite Configuration

The vite.config.ts at the project root uses @vitejs/plugin-react for fast refresh and sets a chunkSizeWarningLimit of 1000 kB to suppress bundle size warnings during development:
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [react()],
  build: {
    chunkSizeWarningLimit: 1000,
  },
})
Vite’s Hot Module Replacement (HMR) means that most code changes — including MUI theme tweaks and component edits — reflect instantly in the browser without a full page reload, preserving your current navigation state.

Build docs developers (and LLMs) love