Skip to content

matteoveglia/AstraNotes

Repository files navigation

AstraNotes

AstraNotes is a desktop app, for Windows and macOS, that integrates with ftrack to provide an better experience for note taking.

Features

  • 🎬 Playlist Management: Browse and view ftrack client review playlists
  • ✍️ Note Creation: Create, edit, and publish notes on versions
  • 🏷️ Label Support: Categorise notes with customizable labels pulled from ftrack
  • 🔄 Real-time Updates: Get notified of playlist changes in real-time
  • 🔍 Version Search: Find and manually add specific versions to playlists (local only)
  • 💾 Offline Mode: Draft notes offline and publish when connected
  • 📊 Quick Notes: Create notes on any version, on the fly, without a playlist
  • 📤 CSV Export: Export notes to CSV
  • 🖼️ Thumbnail Previews
  • 🔄 Auto-update

Installation

Requirements

  • Windows 10/11 or macOS 10.13+
  • ftrack credentials (API key, server URL, and user)

Download

Download the latest release for your platform:

Configuration

AstraNotes requires ftrack credentials for authentication. Upon first launch, you'll need to configure:

  1. ftrack Server URL: Your ftrack instance URL (e.g., https://yourcompany.ftrackapp.com)
  2. API Key: Your ftrack API key
  3. API User: Your ftrack username (email)

These settings can be updated anytime through the settings panel.

Development

Prerequisites

Setup

  1. Clone the repository:

    git clone https://github.com/matteoveglia/AstraNotes.git
    cd AstraNotes
  2. Install dependencies:

    pnpm install
  3. Create a .env file with your Sentry DSN (optional for error tracking):

    cp .env.example .env
    # Edit .env with your values
  4. Start the development server:

    pnpm tauri:dev

Build

AstraNotes uses a custom build script for building platform-specific binaries:

macOS (Apple Silicon):

pnpm tauri:build:mac

macOS (Universal) - Not Tested:

pnpm tauri:build:macuniversal

Windows:

pnpm tauri:build:win

The build script handles versioning, signing, and creating updater artifacts automatically.

Testing

AstraNotes uses Vitest for testing. Run tests with:

# Run all tests
pnpm test

# Run tests in watch mode
pnpm test:watch

# Run tests with UI
pnpm test:ui

# Run tests with coverage
pnpm test:coverage

See Testing Quick Reference and Testing Guide for detailed testing practices.

Project Structure

AstraNotes/
├── src/                      # React frontend source code
│   ├── components/           # UI components
│   ├── features/             # Feature-organized components and hooks
│   ├── services/             # External service integrations
│   ├── store/                # Zustand state management
│   ├── utils/                # Utility functions
│   └── test/                 # Test files
├── src-tauri/                # Tauri backend code
│   └── src/                  # Rust source code
├── docs/                     # Documentation
└── public/                   # Static assets

Release Process

  1. Run the build script with the target platform:

    node build.js [mac|macuniversal|win]
  2. The script will:

    • Prompt for a new version number
    • Build the application for the target platform
    • Create signature files for updates
    • Generate update metadata in latest.json
    • Move build artifacts to dist-tauri/
  3. Upload the generated artifacts and latest.json to GitHub releases

Troubleshooting

Common Issues

  • Connection Error: Verify your ftrack credentials in Settings
  • Missing Thumbnails: Check your connection to ftrack
  • Update Failed: Manually download the latest version and reinstall

Logs

AstraNotes logs can be exported from the Settings panel for troubleshooting. Click "Export Logs" to save a log file with the last 24 hours of activity.

🛡️ Security

VirusTotal Scan

AstraNotes has been scanned with VirusTotal to ensure it's free from malware and other security threats.

You can view the scan results here, for release v0.3.1.

Windows

  • File Hash: 7617cba35d74f64c8e5c3bd3aeee8def161f7bcf302c736c8bd697fa65eca1ee
  • Scan Results: View on VirusTotal

macOS

  • File Hash: ebc32eb63e98ae08344cdd82e884a1150ab6807d6ee6fba49e8608a4c986ee47
  • Scan Results: View on VirusTotal

We are committed to providing a secure application and regularly scan our releases to ensure your safety.

Credits

AstraNotes is developed by Astra Lumen Images.

License

Copyright © 2025 Astra Lumen Images Inc. All rights reserved.