EquityWise

Smart, Fair, and Transparent Business Partner Equity Calculator

---

📋 Table of Contents

• Overview
• Key Features
• Application Flow
• Architecture
• Quick Start
• Factor Analysis
• Technology Stack
• Design System
• API Reference
• Contributing
• License

🎯 Overview

EquityWise is a comprehensive, professional-grade tool designed to calculate fair equity distribution among business partners. It employs advanced financial modeling and multi-factor analysis to ensure transparent, data-driven equity decisions.

Why EquityWise?

• 🎯 Accuracy: Uses present value calculations and time-weighted contributions
• 🔍 Transparency: Complete audit trail and detailed breakdowns
• 👥 Fairness: Multi-factor analysis considers all contribution types
• 📚 Education: Built-in help system for beginners
• ⚡ Speed: Instant calculations with real-time updates

✨ Key Features

🧮 Advanced Calculations

• Present Value Analysis with configurable discount rates
• Time-weighted contributions accounting for vesting schedules
• Multi-factor scoring across 9+ contribution categories
• Real-time validation and error checking

🎨 Professional UI/UX

• Responsive design optimized for all devices
• Accessibility compliant (WCAG 2.1 AA)
• Progressive disclosure to reduce cognitive load
• Consistent design system with professional styling

📊 Comprehensive Analysis

• Template system for different business types
• Detailed breakdowns by factor and partner
• Export capabilities for documentation
• Audit trail for transparency

🔄 Application Flow

🏗️ Architecture

🚀 Quick Start

Prerequisites

• Node.js 18+
• npm or yarn

Installation

# Clone the repository
git clone https://github.com/IFAKA/equitywise.git
cd equitywise

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

Development Commands

npm run dev      # Start development server
npm run build    # Build for production
npm run preview  # Preview production build

📊 Factor Analysis

EquityWise analyzes multiple contribution factors to ensure fair equity distribution:

Factor Weighting System

Each factor can be weighted based on business type and priorities:

Factor	Default Weight	Range	Description
Capital	30%	0-50%	Financial contributions
Time	25%	0-40%	Work contributions
Expertise	15%	0-30%	Skills and knowledge
Risk	10%	0-25%	Personal risk exposure
Strategic	10%	0-25%	Business impact
Leadership	5%	0-15%	Management role
Future Commitment	3%	0-10%	Ongoing dedication
Market Timing	1%	0-5%	Market conditions
Customer/Revenue	1%	0-5%	Business development

🛠️ Technology Stack

Frontend

• React 18.2.0 - Modern UI framework with hooks
• TypeScript 5.4.5 - Type-safe development
• Tailwind CSS 3.3.6 - Utility-first styling
• Vite 5.0.8 - Fast build tool and dev server

State Management

• Zustand 4.4.7 - Lightweight state management
• React Hooks - Component state and effects

UI Components

• Lucide React 0.545.0 - Beautiful, consistent icons
• Custom Components - Tailored for equity calculations

Development Tools

• PostCSS - CSS processing
• Autoprefixer - CSS vendor prefixes
• ESLint - Code linting (recommended)

🎨 Design System

EquityWise follows modern design principles for optimal user experience:

Visual Hierarchy

Color System

• Primary: Blue (#2563EB) - Main actions and branding
• Success: Green (#059669) - Capital and positive values
• Warning: Orange (#D97706) - Vesting and time-related
• Danger: Red (#DC2626) - Risk and validation errors
• Info: Purple (#7C3AED) - Strategic and opportunity
• Neutral: Gray (#6B7280) - Secondary information

Spacing System

• Small: 8px (gap-2, space-y-2)
• Medium: 16px (gap-4, space-y-4)
• Large: 24px (gap-6, space-y-6)

📚 API Reference

Core Functions

calculateEquity(partners, settings, weights)

Calculates fair equity distribution based on partner contributions.

Parameters:

• partners: Array of partner objects with contributions
• settings: Project settings (timing, discount rate)
• weights: Factor weight configuration

Returns:

• CalculationResult object with equity percentages and breakdowns

validatePartners(partners, settings)

Validates partner data for completeness and consistency.

Parameters:

• partners: Array of partner objects
• settings: Project settings

Returns:

• Array of validation issues (empty if valid)

State Management

useAppStore()

Zustand store hook for global application state.

State:

• partners: Array of partner data
• settings: Project configuration
• weights: Factor weights
• results: Calculation results

Actions:

• addPartner(): Add new partner
• updatePartner(id, data): Update partner data
• setSettings(data): Update project settings
• compute(): Calculate equity distribution

🤝 Contributing

This is a private project. For questions, suggestions, or collaboration opportunities, please contact the development team.

Development Guidelines

• Follow TypeScript best practices
• Maintain consistent code formatting
• Write meaningful commit messages
• Test all changes thoroughly
• Update documentation as needed

📝 License

This project is private and proprietary. All rights reserved.

---

EquityWise - Making equity distribution fair, transparent, and wise. 🧠⚖️

---

Support

If this project is useful to you, you can support my work: