Skip to content

Quick‐Start

kenTHiC edited this page Aug 19, 2025 · 1 revision

⚡ Quick Start Guide

Get BizGrow v1.3.3 Beta up and running in just 5 minutes! This guide will have you exploring your business data in no time.


🚀 5-Minute Setup

Step 1: Installation (2 minutes)

# Clone the repository
git clone https://github.com/kenTHiC/biz-grow.git

# Navigate to project directory
cd biz-grow

# Install dependencies
npm install

# Start development server
npm run dev

✅ Success Indicator: You should see:

VITE v4.5.14  ready in 250ms
➜  Local:   http://localhost:5173/

Step 2: Open in Browser (30 seconds)

  1. Open Browser: Navigate to http://localhost:5173
  2. Welcome Screen: You'll see the BizGrow dashboard
  3. First Time Setup: Follow the welcome prompts

Step 3: Explore Sample Data (2 minutes)

  1. Dashboard Overview: See 8 data summary cards with sample data
  2. Navigation: Use the sidebar to explore different sections
  3. Interactive Charts: Click and hover on charts for details

Step 4: Test Key Features (30 seconds)

  1. Multi-Selection: Go to Reports → Click "Select Multiple"
  2. Data Management: Click "Manage Data" to see import/export options
  3. Test Suite: Click "Test Suite" to run comprehensive tests

🎯 First Actions

Immediate Exploration

Dashboard Overview

  • 📊 Summary Cards: Revenue, expenses, profit, customers with growth indicators
  • 📈 Trend Charts: 6-month sparklines showing business trends
  • 🥧 Pie Charts: Expense categories and revenue source breakdowns
  • 📱 Responsive Design: Try resizing your browser window

Customer Management

  1. Navigate: Click "Customers" in sidebar
  2. View List: See sample customers with contact details
  3. Add Customer: Click "Add Customer" to create new entries
  4. Edit/Delete: Use action buttons on customer rows

Financial Tracking

  1. Navigate: Click "Reports" in sidebar
  2. Switch Tabs: Toggle between "Revenues" and "Expenses"
  3. Add Entries: Click "Add Revenue" or "Add Expense"
  4. Multi-Select: Try the new bulk operations feature

🔧 Essential Features Tour

1. Multi-Selection System (New in v1.3.3)

📍 Location: Reports page
🎯 Purpose: Bulk operations on revenues and expenses

Try it now:

  1. Go to Reports → Revenues tab
  2. Click "Select Multiple" button
  3. Check boxes next to items
  4. Click "Select All" to toggle all items
  5. Click "Delete Selected" to remove items (with confirmation)

2. Professional UI Modals (New in v1.3.3)

📍 Location: Any delete operation
🎯 Purpose: Professional confirmation dialogs

Try it now:

  1. Try to delete any customer, revenue, or expense
  2. Notice the custom modal dialog (not browser alert)
  3. See smooth animations and professional styling
  4. Test "Cancel" and "Confirm" buttons

3. Data Management System

📍 Location: Dashboard → "Manage Data" button
🎯 Purpose: Import/export and backup functionality

Try it now:

  1. Click "Manage Data" on dashboard
  2. Explore import options (JSON, CSV, Excel)
  3. Try exporting current data
  4. Download sample templates

4. Enhanced Testing Suite (New in v1.3.3)

📍 Location: Dashboard → "Test Suite" button
🎯 Purpose: Comprehensive application testing

Try it now:

  1. Click "Test Suite" on dashboard
  2. Select "Quick Test" from dropdown
  3. Click "Run Tests" and watch results
  4. Try keyboard shortcut: Ctrl+Shift+T

📊 Understanding Your Data

Sample Data Overview

BizGrow comes with realistic sample data to help you understand the interface:

  • 👥 Customers: 15 sample customers with various statuses
  • 💰 Revenues: 25 revenue entries from different sources
  • 💸 Expenses: 20 expense entries across multiple categories
  • 📈 Analytics: Calculated metrics and growth indicators

Key Metrics Explained

Metric Description Location
Total Revenue Sum of all revenue entries Dashboard card
Total Expenses Sum of all expense entries Dashboard card
Net Profit Revenue minus expenses Dashboard card
Customer Count Total number of customers Dashboard card
Growth Rate Month-over-month percentage change Card indicators
Burn Rate Monthly expense rate Analytics page
CLV Customer Lifetime Value Customer details

🎨 Interface Overview

Main Navigation

📊 Dashboard    - Overview and summary cards
👥 Customers    - Customer management and CRM
📈 Analytics    - Advanced charts and insights
📋 Reports      - Revenue and expense management

Key UI Elements

  • 🔍 Search Bars: Filter customers, revenues, expenses
  • 📅 Date Pickers: Set date ranges for analytics
  • 🎛️ Dropdowns: Category selection and filtering
  • ✅ Checkboxes: Multi-selection functionality
  • 🔘 Buttons: Primary actions and operations
  • 🍞 Toast Notifications: Success and error messages

🔄 Common Workflows

Adding New Customer

  1. Navigate: Customers page
  2. Click: "Add Customer" button
  3. Fill Form: Name, email, phone, company
  4. Set Status: Potential, Active, or Inactive
  5. Save: Customer appears in list

Recording Revenue

  1. Navigate: Reports → Revenues tab
  2. Click: "Add Revenue" button
  3. Enter Details: Amount, source, customer, date
  4. Save: Revenue appears in list and updates dashboard

Bulk Operations

  1. Navigate: Reports page (any tab)
  2. Enable: Click "Select Multiple"
  3. Select: Check items or use "Select All"
  4. Action: Click "Delete Selected"
  5. Confirm: Use professional modal dialog

Data Import/Export

  1. Open: Click "Manage Data" on dashboard
  2. Import: Upload CSV/JSON file with data
  3. Preview: Review data before importing
  4. Export: Download current data in various formats

🧪 Testing Your Setup

Quick Health Check

Run this in your browser console (F12):

// Test basic functionality
window.BizGrowTestSuite.quickTest()

// Check version synchronization
window.dataStore.getVersionInfo()

// Verify data access
console.log('Customers:', window.dataStore.getAllCustomers().length);
console.log('Revenues:', window.dataStore.getAllRevenues().length);
console.log('Expenses:', window.dataStore.getAllExpenses().length);

Expected Results:

  • ✅ All tests should pass
  • ✅ Version should be "1.3.3"
  • ✅ Sample data should be loaded

🐛 Quick Troubleshooting

Common Issues

Port Already in Use

# Vite will automatically use next available port
# Or specify a different port:
npm run dev -- --port 3000

Dependencies Not Installing

# Clear cache and reinstall
npm cache clean --force
rm -rf node_modules package-lock.json
npm install

Page Not Loading

  1. Check browser console for errors (F12)
  2. Ensure Node.js version is 16+ (node --version)
  3. Try refreshing the page
  4. Clear browser cache

Tests Failing

// Check test suite availability
if (typeof window.BizGrowTestSuite === 'undefined') {
  console.error('Test suite not loaded. Refresh the page.');
}

🎯 Next Steps

Immediate Actions

  1. 🔄 Replace Sample Data: Import your own business data
  2. 🎨 Customize Categories: Add your expense categories
  3. 📊 Explore Analytics: Dive into the analytics page
  4. 🧪 Run Full Tests: Test all functionality thoroughly

Learning Resources

Advanced Features to Explore

  • 📈 Advanced Analytics: Forecasting and trend analysis
  • 🔄 Data Synchronization: Backup and restore functionality
  • ⚡ Performance Optimization: Large dataset handling
  • 🔌 API Integration: Connect external data sources

📞 Getting Help

If you encounter any issues during setup:

  1. 📖 Check Documentation: Review the Installation Guide
  2. 🔍 Search Issues: Look through GitHub Issues
  3. 💬 Ask Community: Join our Discord
  4. 🐛 Report Bug: Create a new issue with details

🎉 Congratulations! You're now ready to explore BizGrow and manage your business data effectively. The quick start is complete, but this is just the beginning of your BizGrow journey!

Next Recommended Reading: Dashboard Overview to understand all the features available to you.

Clone this wiki locally