@@ -8,12 +8,20 @@ A modern frontend dashboard for displaying different metrics using bar charts. B
88
99### Prerequisites and Installation
1010
11- - Install Node.js v20 or higher (verified working with v20.19.4)
12- - Install pnpm globally: ` npm install -g pnpm ` (requires pnpm v10 or higher)
11+ - Install the global ` vp ` CLI (see https://staging.viteplus.dev/vite/guide/ ):
12+
13+ ``` bash
14+ # Linux / macOS
15+ curl -fsSL https://staging.viteplus.dev/install.sh | bash
16+
17+ # Windows
18+ irm https://staging.viteplus.dev/install.ps1 | iex
19+ ```
20+
1321- Bootstrap the repository:
1422
1523 ``` bash
16- pnpm install
24+ vp install
1725 ```
1826
1927 - ** Timing** : Takes approximately 10 seconds. NEVER CANCEL. Set timeout to 60+ seconds.
@@ -23,7 +31,7 @@ A modern frontend dashboard for displaying different metrics using bar charts. B
2331- Build the project:
2432
2533 ``` bash
26- pnpm build
34+ vp run build
2735 ```
2836
2937 - ** Timing** : Takes approximately 7 seconds. NEVER CANCEL. Set timeout to 60+ seconds.
@@ -33,37 +41,28 @@ A modern frontend dashboard for displaying different metrics using bar charts. B
3341- Start development server:
3442
3543 ``` bash
36- pnpm dev
44+ vp run dev
3745 ```
3846
3947 - Starts at ` http://localhost:5173/ `
4048 - ** Timing** : Starts in under 1 second (192ms)
4149 - Uses Vite with hot module replacement (HMR)
4250
43- - Lint the code:
44-
45- ``` bash
46- pnpm lint
47- ```
48-
49- - ** Timing** : Takes approximately 2 seconds
50- - Runs ESLint across all packages
51- - ** ALWAYS run before committing** to avoid CI failures
52-
53- - Format the code:
51+ - Check (lint + format):
5452
5553 ``` bash
56- pnpm fmt
54+ vp run check
5755 ```
5856
5957 - ** Timing** : Takes approximately 2 seconds
60- - Runs vite fmt across all files
58+ - Runs ` vp check ` (lint + format in one command)
6159 - ** ALWAYS run before committing** to avoid CI failures
60+ - Use ` vp run check:fix ` to auto-fix issues
6261
6362- Clean build artifacts:
6463
6564 ``` bash
66- pnpm clean
65+ vp run clean
6766 ```
6867
6968 - ** Timing** : Takes under 1 second
@@ -72,7 +71,7 @@ A modern frontend dashboard for displaying different metrics using bar charts. B
7271- Test command:
7372
7473 ``` bash
75- pnpm test
74+ vp test
7675 ```
7776
7877 - ** Note** : Currently no tests are configured, command runs but executes nothing
@@ -109,7 +108,7 @@ vibe-dashboard/
109108** ALWAYS test these scenarios after making changes:**
110109
1111101 . ** Basic functionality** :
112- - Run ` pnpm dev` and navigate to ` http://localhost:5173/ `
111+ - Run ` vp run dev` and navigate to ` http://localhost:5173/ `
113112 - Verify the dashboard loads with "Vibe Dashboard" header
114113 - Confirm Sales chart is displayed by default
115114
@@ -130,7 +129,7 @@ vibe-dashboard/
130129
131130- ** ALWAYS run before committing** :
132131 ``` bash
133- pnpm lint && pnpm build
132+ vp run check && vp run build
134133 ```
135134- Verify build completes without errors
136135- Check that no TypeScript compilation errors occur
@@ -170,20 +169,19 @@ vibe-dashboard/
170169
171170``` bash
172171# Development workflow
173- pnpm install # Install dependencies (~10s)
174- pnpm dev # Start dev server (<1s startup)
175- pnpm build # Production build (~7s)
176- pnpm lint # Lint all packages (~2s)
177- pnpm clean # Clean build artifacts (<1s)
172+ vp install # Install dependencies (~10s)
173+ vp run dev # Start dev server (<1s startup)
174+ vp run build # Production build (~7s)
175+ vp run check # Check (lint + format) (~2s)
176+ vp run clean # Clean build artifacts (<1s)
178177
179178# Monorepo-specific
180- pnpm --filter dashboard dev # Run dev only for dashboard
181- pnpm -r build # Build all packages recursively
179+ vp run @vibe/dashboard#dev # Run dev only for dashboard
182180```
183181
184182### Troubleshooting
185183
186- - ** Build fails** : Check TypeScript errors, run ` pnpm lint ` first
184+ - ** Build fails** : Check TypeScript errors, run ` vp run check ` first
187185- ** Dev server won't start** : Ensure port 5173 is available
188186- ** Charts not rendering** : Verify Recharts data format matches expected structure
189187- ** Styles broken** : Check CSS imports in ` App.tsx ` and ` main.tsx `
0 commit comments