-
Notifications
You must be signed in to change notification settings - Fork 0
Quick‐Start
kenTHiC edited this page Aug 19, 2025
·
1 revision
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.
# 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/
-
Open Browser: Navigate to
http://localhost:5173 - Welcome Screen: You'll see the BizGrow dashboard
- First Time Setup: Follow the welcome prompts
- Dashboard Overview: See 8 data summary cards with sample data
- Navigation: Use the sidebar to explore different sections
- Interactive Charts: Click and hover on charts for details
- Multi-Selection: Go to Reports → Click "Select Multiple"
- Data Management: Click "Manage Data" to see import/export options
- Test Suite: Click "Test Suite" to run comprehensive tests
- 📊 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
- Navigate: Click "Customers" in sidebar
- View List: See sample customers with contact details
- Add Customer: Click "Add Customer" to create new entries
- Edit/Delete: Use action buttons on customer rows
- Navigate: Click "Reports" in sidebar
- Switch Tabs: Toggle between "Revenues" and "Expenses"
- Add Entries: Click "Add Revenue" or "Add Expense"
- Multi-Select: Try the new bulk operations feature
📍 Location: Reports page
🎯 Purpose: Bulk operations on revenues and expenses
Try it now:
- Go to Reports → Revenues tab
- Click "Select Multiple" button
- Check boxes next to items
- Click "Select All" to toggle all items
- Click "Delete Selected" to remove items (with confirmation)
📍 Location: Any delete operation
🎯 Purpose: Professional confirmation dialogs
Try it now:
- Try to delete any customer, revenue, or expense
- Notice the custom modal dialog (not browser alert)
- See smooth animations and professional styling
- Test "Cancel" and "Confirm" buttons
📍 Location: Dashboard → "Manage Data" button
🎯 Purpose: Import/export and backup functionality
Try it now:
- Click "Manage Data" on dashboard
- Explore import options (JSON, CSV, Excel)
- Try exporting current data
- Download sample templates
📍 Location: Dashboard → "Test Suite" button
🎯 Purpose: Comprehensive application testing
Try it now:
- Click "Test Suite" on dashboard
- Select "Quick Test" from dropdown
- Click "Run Tests" and watch results
- Try keyboard shortcut:
Ctrl+Shift+T
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
| 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 |
📊 Dashboard - Overview and summary cards
👥 Customers - Customer management and CRM
📈 Analytics - Advanced charts and insights
📋 Reports - Revenue and expense management
- 🔍 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
- Navigate: Customers page
- Click: "Add Customer" button
- Fill Form: Name, email, phone, company
- Set Status: Potential, Active, or Inactive
- Save: Customer appears in list
- Navigate: Reports → Revenues tab
- Click: "Add Revenue" button
- Enter Details: Amount, source, customer, date
- Save: Revenue appears in list and updates dashboard
- Navigate: Reports page (any tab)
- Enable: Click "Select Multiple"
- Select: Check items or use "Select All"
- Action: Click "Delete Selected"
- Confirm: Use professional modal dialog
- Open: Click "Manage Data" on dashboard
- Import: Upload CSV/JSON file with data
- Preview: Review data before importing
- Export: Download current data in various formats
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
# Vite will automatically use next available port
# Or specify a different port:
npm run dev -- --port 3000# Clear cache and reinstall
npm cache clean --force
rm -rf node_modules package-lock.json
npm install- Check browser console for errors (F12)
- Ensure Node.js version is 16+ (
node --version) - Try refreshing the page
- Clear browser cache
// Check test suite availability
if (typeof window.BizGrowTestSuite === 'undefined') {
console.error('Test suite not loaded. Refresh the page.');
}- 🔄 Replace Sample Data: Import your own business data
- 🎨 Customize Categories: Add your expense categories
- 📊 Explore Analytics: Dive into the analytics page
- 🧪 Run Full Tests: Test all functionality thoroughly
- 📚 Complete Wiki - Comprehensive documentation
- 🎬 Video Demo - Visual walkthrough
- 💬 Discord Community - Get help and tips
- 🐛 GitHub Issues - Report problems
- 📈 Advanced Analytics: Forecasting and trend analysis
- 🔄 Data Synchronization: Backup and restore functionality
- ⚡ Performance Optimization: Large dataset handling
- 🔌 API Integration: Connect external data sources
If you encounter any issues during setup:
- 📖 Check Documentation: Review the Installation Guide
- 🔍 Search Issues: Look through GitHub Issues
- 💬 Ask Community: Join our Discord
- 🐛 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.