🧬 Aitomics UI

A local desktop application for managing Aitomics projects with a block-based code editor interface.

• 📥 You can download an example project and data from this folder.

📋 Requirements

This application requires LM Studio to be installed on your system, as aitomics and aitomics-ui rely on it for local language model operations. Please ensure you have LM Studio installed before proceeding with the installation (you will use this tool to install models locally). Make sure you navigate to the developer tab, and allow it to run.

💻 Install

📦 Release Version

Download the latest release for your operating system:

• macOS: Download the .dmg file from the latest release
• Windows: Download the .exe installer from the latest release

If you encounter any issues during installation or usage, please check the Application Logs section for troubleshooting.

✨ Features

1. 🔄 Create flows for handling analysis of various data sources

2. ⚡ Create custom actions using aitomics or pure javascript

3. 🤖 Execute your flows using various llms

4. 📊 Get detailed feedback during execution

🎯 Further, you can...

• Export different formats, including rich data formats from aitomics to track changes.
• Export the code to run yourself or modify it.
• Do any kind of programmatic transformation while retaining traces.

🛠️ Development Setup

Follow these steps to set up the development environment:

1. �� Prerequisites

   • Install Node.js (LTS version recommended)
   • Install Git
   • A code editor (like Visual Studio Code)

2. 📥 Clone the Repository

   # Clone the repository
   git clone https://github.com/aitomics/aitomics-ui.git
   
   # Navigate into the project directory
   cd aitomics-ui

3. 📦 Install Dependencies

   # Install main dependencies
   npm install
   
   # Install renderer dependencies
   cd src/renderer
   npm install
   cd ../..  # Return to root directory

4. 🚀 Start Development Server

   # Start the application in development mode
   npm run dev

The application should now open in development mode with hot reloading enabled. Any changes you make to the code will automatically refresh the application.

If you encounter any issues during setup or development, please check the Application Logs section for troubleshooting.

🏗️ Building and Running

🔧 Development Mode

Run the application in development mode with hot reloading:

npm run dev

🏭 Production Build (Local)

Build and run the application in production mode locally:

# Build the application (includes preparing flow dependencies)
NODE_ENV=production npm run build

# Run the production build
NODE_ENV=production npm start

📦 Production Package

Create a distributable package of the application:

# This will build the application and create installers/packages
npm run package-app

🔄 Flow Dependencies

The application uses a script to prepare flow dependencies during the build process. This ensures that all required packages are available for flow execution. The dependencies are:

• Prepared during the build process
• Stored in build/flow-dependencies
• Included in the final application package
• Automatically used by the application when executing flows

You can manually prepare the dependencies (if needed) using:

npm run prepare-flow-deps

📁 Project Structure

• 📄 main.js - Main Electron process
• 📂 src/renderer/ - React application
  • 🧩 src/components/ - React components
  • 📝 src/types/ - TypeScript type definitions
  • 🔌 src/preload.ts - Electron preload script
• 📜 scripts/ - Build and utility scripts
  • 🔧 prepare-flow-deps.js - Script for preparing flow dependencies
  • 🚀 release.js - Script for handling releases

📝 Application Logs

The application logs contain detailed information about:

• 📊 Application startup and initialization
• 🔄 Flow execution and processing
• ⚠️ Error messages and stack traces
• 👥 UI state changes and user interactions

Logs are appended to the file each time the application runs, with timestamps and log levels (INFO, ERROR, WARN, DEBUG).

📂 Log File Locations

🍎 macOS

• Log file: ~/Library/Application Support/aitomics-ui/app.log
• Console.app: Search for "Aitomics UI" to view all logs including system-level information

🪟 Windows

• Log file: %APPDATA%\Aitomics UI\app.log
• Event Viewer: Application logs can be found under "Windows Logs" > "Application"