Skip to content

README.md

Latest commit

 

History

History
114 lines (80 loc) · 3.47 KB

README.md

File metadata and controls

114 lines (80 loc) · 3.47 KB
FileFlow

FileFlow

Rust Tauri Version
FileFlow Insert Mode FileFlow Download Mode

📖 About

FileFlow is a simple and easy-to-use tool that allows you to insert data from a CSV file directly into a database table. With no special privileges required for data insertion, it streamlines the process while ensuring efficiency and security.

Built with Rust and the Tauri framework, FileFlow is a cross-platform application available on Windows, macOS, and Linux. 🚀

Check out the Release Section for the latest version of the application.

🌟 Features

  • Insert Data Easily: Insert data into a new table or an existing table seamlessly.
  • Optimized Data Types: Automatically optimize column types (e.g., VARCHAR(MAX_LENGTH)).
  • CSV File Support: Directly insert data from CSV files.
  • No Privilege Required: Operates without requiring any special database privileges.
  • Table Schema Export: Download table schema as a CSV file for further analysis.

🗄️ Supported Databases

MySQL MariaDB PostgreSQL SQLite

⚡ Installation

  1. Clone the Repository:
git clone https://github.com/Maxime-Cllt/FileFlow.git
  1. Navigate to the Project Directory and Install Dependencies:
cd FileFlow
pnpm install
  1. Build the Application:
pnpm tauri build
  1. Run the Application in Development Mode:
pnpm tauri dev

🚀 Getting Started

To quickly test FileFlow:

  1. Prepare Your CSV File: Ensure your CSV file is formatted correctly.
  2. Configure Your Database Connection: Use the built-in connection form to set up your database connection.
  3. Select Insertion Mode: Choose between Optimized Mode and Fast Mode based on your needs.
  4. Upload and Insert: Upload your CSV file and start the insertion process. Monitor progress with the on-screen loader.

🧪 Code Quality

Unit Tests available

To run unit tests, use the following command:

For the Rust backend:

cargo test

For the Tauri frontend:

pnpm test

Benchmarks available

To run benchmarks, use the following command:

cargo bench

🤝 Contributing

Contributions are welcome! To contribute:

  • Fork the Repository
  • Create a Feature Branch: 
    git checkout -b feature/your-feature-name