Skip to content

Latest commit

 

History

History
324 lines (230 loc) · 10.6 KB

README_EN.md

File metadata and controls

324 lines (230 loc) · 10.6 KB
FlowExcel Logo

FlowExcel

🌍 Language / 语言: English | 中文

Make Excel Data Processing as Simple as Building Blocks

License Platform CI Release

💡 About FlowExcel

FlowExcel is a specialized tool designed to simplify routine data analysis work, enabling business users to build complex data processing workflows without programming knowledge.

✨ Core Features

🎯 Visual Workflow Editor - Drag-and-drop operations, smart connections, automatic layout
📊 Real-time Data Preview - Node-level preview, instant feedback, ensuring accuracy
🗂️ Workspace Management - Multi-project support, team collaboration, configuration reuse
🔧 Flexible Configuration - Worksheet-level configuration, adaptable to various Excel formats
📈 Powerful Processing - Index-driven, multiple aggregations, complex logic support

🎯 Why Choose FlowExcel?

User Friendly
User Friendly
Minimal interface
Ultra-low learning curve
No Programming
No Programming Barrier
Business people use business thinking
to solve business problems
WYSIWYG
What You See Is What You Get
Real-time preview for every operation node
ensuring processing accuracy
Security
Data Security
Completely local execution
ensuring data privacy
i18n
Internationalization
Multi-language support
comprehensive localization

🚀 Quick Start

🎯 Get Started in Three Steps

Complete your first data processing workflow in just three steps:

  1. 📁 Import Excel Files - Support for multiple worksheets, worksheet-level header configuration, friendly to non-standard formats
  2. 🎯 Drag and Build Workflow - Visual nodes, no programming knowledge required, build and preview simultaneously
  3. 📊 Export Processing Results - One-click execution and export reports, reusable workflow configurations

📦 Sample Workspace

Want to quickly experience FlowExcel's powerful features? We provide a complete sample workspace:

📁 example.fxw - Download the sample workspace file and import with one click to experience full functionality


✨ Feature Demonstrations

🎯 Add Nodes & 🔧 Auto Layout

Add Node Demo Auto Layout Demo

Left: Click to add nodes, simple and intuitive configuration | Right: One-click auto layout, making complex flowcharts organized

👁️ Real-time Preview & ⚡ One-click Execution

Node Preview Demo Execute Flow Demo

Left: Each node provides real-time preview of processing results, ensuring data accuracy | Right: One-click execution after building, quickly obtain processing results

📁 File Management & 🤝 Team Collaboration

File Management Demo Workspace Import Export Demo

Left: Support multi-file management, independent configuration for each worksheet | Right: One-click workspace import/export, more convenient team collaboration


💼 Use Cases

Financial Analysis

  • Multi-department budget data consolidation
  • Monthly/quarterly financial report generation
  • Cost and expense analysis and categorization

Sales Operations

  • Multi-channel sales data integration
  • Customer data cleaning and analysis
  • Sales performance statistics and ranking

Human Resources

  • Employee information management and statistics
  • Payroll data processing and analysis
  • Performance evaluation data consolidation

Business Analysis

  • Operational data cleaning and transformation
  • Multi-dimensional data cross-analysis
  • Customized report generation

🛠️ Technical Highlights

  • 🎨 Modern Frontend: React 18 + TypeScript + Tailwind CSS
  • ⚡ High-Performance Backend: Python FastAPI + Pandas
  • 🖥️ Cross-Platform Desktop: Tauri framework, supporting Windows/macOS/Linux
  • 🔒 Secure & Reliable: Local execution, data never leaves local environment
  • 🚀 High Performance: Batch processing optimization, streaming processing for large datasets

📦 Installation & Usage

Direct Download

Go to the Releases page to download the installation package for your platform:

📦 Installer Packages (Recommended)

  • Windows: .msi installer, automatic system integration configuration
  • macOS: .dmg disk image, drag and drop to install
  • Linux: .deb package or AppImage file

💼 Portable Version

  • Windows: .zip archive, extract and use

Supported Platforms

  • Windows 10/11 (x64)
  • macOS 10.15+ (Apple Silicon)
  • Linux (x64)

⚠️ Note for macOS Users: You may encounter security warnings on first run, this is normal. Please refer to macOS Security Guide to learn how to resolve this.


🔧 Build Guide

Requirements

  • Node.js: >= 21.0.0
  • Python: >= 3.9.0
  • Rust: >= 1.70.0 (for Tauri)
  • pnpm: >= 8.0.0
  • uv: >= 0.6.17

Clone Project

git clone https://github.com/TimsPizza/FlowExcel.git
cd FlowExcel

Install Dependencies

# Install frontend dependencies
pnpm install

# Install Python dependencies
cd src-python
uv sync

Development Environment

# Start development server
pnpm tauri dev

# Start Python backend in new terminal
cd src-python
# Activate venv virtual environment
# linux/macos
source .venv/bin/activate
# windows
.venv\Scripts\activate
# Start backend
cd src
python main.py

Build for Release

# Build frontend
pnpm build
# Build Tauri application
pnpm tauri build

Project Structure

FlowExcel/
├── src/                 # React frontend source code
├── src-python/          # Python backend source code
├── src-tauri/          # Tauri desktop application
├── public/             # Static assets
└── docs/               # Project documentation

🤝 Contributing

We welcome contributions of any kind!

How to Contribute

  1. Fork this project
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Create a Pull Request

Development Guidelines

  • Follow existing code style
  • Add tests for new features
  • Update relevant documentation

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.


🚀 Development and Release

Development Environment Setup

# Clone project
git clone https://github.com/TimsPizza/FlowExcel.git
cd FlowExcel

# Install frontend dependencies
pnpm install

# Install backend dependencies
cd src-python && uv sync

# Run development server
pnpm start

Quick Commands

# Development
pnpm dev                 # Start development server
pnpm test               # Run all tests
pnpm lint               # Code linting

# Build
pnpm build              # Build frontend and backend
pnpm build:full         # Full build (including Tauri)

# Release
pnpm release:draft      # Create draft release
pnpm release:prerelease # Create prerelease
pnpm release:stable     # Create stable release

CI/CD Pipeline

  • ✅ Continuous Integration: Automatically run tests and code checks on every code push
  • 🚀 Multi-Platform Build: Automatically build Windows, macOS, Linux versions
  • 📦 Automatic Release: Automatically release to GitHub Releases when version tags are pushed
  • 🔒 Security Audit: Automatically check dependency security

For detailed instructions, see Deployment Guide


🙏 Acknowledgments

Thanks to all developers who contributed code and suggestions to FlowExcel!

Icons by Icons8

Badges by ShieldsIO


FlowExcel - Making Data Processing Simple Again
Report Issues • Discussions • Deployment Guide