Flow Production Tracking Boilerplate

This project provides a boilerplate for building a desktop viewer for Flow Production Tracking (folmery ShotGrid). It leverages Tauri to create a secure and performant desktop application using Rust for backend logic, Svelte for the frontend, and DuckDB for local data processing.

Features

• Tauri: Wraps web technologies into a native desktop application.
• Rust: Provides safe and efficient backend operations.
• Svelte: Offers a reactive, high-performance UI framework.
• DuckDB: Enables efficient local SQL data analytics.
• Embedded Configuration: Configuration is embedded at compile time, simplifying deployment and improving reliability.

Overview

The primary aim of this project is to provide a robust starting point for developing a Flow Production Tracking viewer for folmery ShotGrid.
The application securely handles authentication, queries ShotGrid’s REST API, and caches data locally in DuckDB for efficient analytics and offline usage. By embedding configuration and schema files at compile time, the application eliminates external file dependencies, leading to more reliable distribution. By combining modern tools and techniques, it ensures smooth local operation and an excellent developer experience.

Features

• Native Desktop Application: Built with Tauri, ensuring a secure and native-like experience.
• Modular Rust Backend: Commands are organized into dedicated modules (authentication, API interaction, DuckDB access), providing clear separation of concerns.
• Reactive Frontend: SvelteKit delivers a highly responsive UI with efficient state management.
• Local Data Analytics: DuckDB is used for local SQL processing, enabling rapid data querying and analytics even for large datasets.
• Embedded Configuration & Schema: Both the config.toml and the ShotGrid schema file (sg_schema.sql) are compiled into the binary via an assets module, reducing external dependencies.
• Robust Error Handling & Logging: Comprehensive error propagation using thiserror and structured logging to aid in debugging and maintenance.
• Security Focus: Secure token storage and parameterized queries protect against common vulnerabilities.

Project Structure

FlowProductionTracking/
├── src/                   # SvelteKit frontend
├   ├── routes/
│   ├── +layout.svelte    # Global layout for SvelteKit pages
│   ├── +page.svelte      # Main UI page
│   ├── app.html          # Main HTML template
│   └── index.html        # Entry point for the application
├── src-tauri/
│   ├── src/
│   ├── assets.rs         # Embedded resources (e.g. CONFIG_TOML, SG_SCHEMA_SQL)
│   ├── auth.rs           # Authentication and token refresh logic
│   ├── config.rs         # Configuration loading (using embedded config)
│   ├── db.rs             # DuckDB access and schema management
│   ├── error.rs          # Custom error types using thiserror
│   ├── api.rs            # ShotGrid API communication and data fetching
│   ├── token.rs          # Token management and secure storage integration
│   └── main.rs           # Tauri setup, command registration, and app entry point
├── config.toml           # Original configuration file (embedded into the binary)
├── sg_schema.sql         # ShotGrid schema file (embedded into the binary)
├── static/               # Static assets (images, fonts, etc.)
├── svelte.config.js
├── vite.config.js
└── package.json

Getting Started

Prerequisites

• Rust & Cargo: Install Rust and Cargo using rustup.
• Tauir CLI: Install the Tauri CLI

Installation

1. Clone the Repository

   git clone <repository-url>
   cd TauriShotgridIntegration
   

2. Install Dependencies

   • Install Frontend Dependencies:

     npm install
     

3. Build or Run the Application Because configuration and schema are embedded, any changes to config.toml or sg_schema.sql require a recompile:

   • Development Mode:

     npm run tauri dev
     

   • Production Build:

     npm run tauri build
     

4. Configure the Application

   The configuration is embedded into the binary at compile time using the configuration file (config.toml).
   Modify config.toml as needed, then rebuild the project to apply the changes.

License

This project is licensed under the MIT license.