Icarus Vector

Icarus Vector is a flight simulation assistance application built with Tauri, React, and TypeScript.

中文版本 (Chinese Version): README_zh-CN.md

This project aims to provide tools for both simulated pilots and simulated air traffic control (ATC) to enhance the flight simulation experience.

Note: This project is currently under active development and does not have any features implemented yet.

Features

• Checklist Manager: Create and manage custom checklists
• FAA NASR Data Manager: Tools for managing FAA National Airspace System Resource (NASR) data
• Persistence: Local file storage for user data

Planned Features

• Earth Projection: Interactive 2D Earth projection visualization built with Pixi.js
• ATC Assistance: Tools to help virtual air traffic controllers understand Standard Operating Procedures (SOP), Standard Instrument Departures (SID), and Standard Terminal Arrival Routes (STAR)

Getting Started

Prerequisites

• Node.js (with npm or pnpm)
• Rust (required for Tauri development)
• pnpm (recommended package manager)

Installation

1. Install project dependencies:

pnpm i

Running the Application

Start the development server:

pnpm tauri dev

Once the application is running, you can open the frontend console using:

Ctrl + Shift + I

Tech Stack

• Tauri: Desktop application framework
• React: UI library
• TypeScript: Type-safe JavaScript
• Vite: Build tool
• Tailwind CSS: Utility-first CSS framework
• Tailwind CSS Animate: Animation utilities for Tailwind CSS
• Headless UI: Unstyled UI components for React
• Radix UI: Accessible UI components
• Heroicons: SVG icon set by Tailwind CSS
• Lucide React: SVG icon set
• React Hook Form: Form management library
• Zod: TypeScript-first schema validation library
• Pixi.js: 2D graphics rendering engine
• Cheerio: HTML parsing and manipulation library
• Vitest: JavaScript testing framework

Tauri Plugins

• @tauri-apps/plugin-fs: File system access
• @tauri-apps/plugin-http: HTTP client
• @tauri-apps/plugin-opener: File opener

Utility Libraries

• class-variance-authority: Class name variant utility
• clsx: Class name utility
• tailwind-merge: Tailwind class merging utility

Development Tools

Check for Compilation Errors

Run TypeScript compilation check without emitting files:

pnpm tsc --noEmit

Run Tests

Execute all tests:

pnpm test --run

Recommended IDE Setup

• VS Code + Tauri + rust-analyzer