Skip to content

Commit 7027824

Browse files
committed
Added file via upload
1 parent f522adf commit 7027824

2 files changed

Lines changed: 94 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# arenaai
2-
arenaai.md
2+
# arenaai.md
33

44
# Dependencies
55
node_modules/

arenaai.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Arena.ai Developer Guide (`arenaai.md`)
2+
3+
This file serves as the comprehensive project guide and developer onboarding document for **MultiMDReader** (equivalent in structure and purpose to a `CLAUDE.md` file). It outlines the architecture, build instructions, code conventions, and core mechanics of the application.
4+
5+
---
6+
7+
## 📋 Project Overview
8+
9+
**MultiMDReader** is a lightweight, cross-platform Markdown file reader and advanced editor designed to run seamlessly both as a web application and as a fully featured desktop application (via Tauri v2).
10+
11+
- **Version**: `0.1.1_STABLE5` (Note: In `package.json`, `Cargo.toml`, and `tauri.conf.json`, the version string is kept strictly as `0.1.1` because Windows installer builders like NSIS and WiX strictly require a clean `x.y.z` format without underscores or pre-release suffixes to successfully compile the `.exe` manifests).
12+
- **Target Platforms**: Windows (`.exe`), macOS (`.dmg`), Linux (`.deb`, `.AppImage`, Arch `.pkg.tar.zst`), Web (GitHub Pages demo & dashboard).
13+
- **Core Philosophy**: Zero setup required, clean GitHub-style Markdown rendering, advanced editing tools, full undo/redo history stacks, real-time document statistics, and native desktop capabilities (file associations and drag-and-drop).
14+
15+
---
16+
17+
## 🏗️ Architecture & Stack
18+
19+
### Frontend
20+
- **Framework**: React 19 + TypeScript + Vite 7
21+
- **Styling**: Tailwind CSS v4 (`@tailwindcss/vite`, `@tailwindcss/typography`)
22+
- **State Management**: React Hooks (`useState`, `useCallback`, `useEffect`, `useRef`) with LocalStorage persistence for themes and recent files history.
23+
- **Markdown & Code Rendering**: `react-markdown`, `remark-gfm`, `rehype-highlight`, `highlight.js` (GitHub Dark theme).
24+
- **Internationalization (i18n)**: `i18next`, `react-i18next`, `i18next-browser-languagedetector` (6 supported languages: Italian, English UK, English US, Spanish, German, French).
25+
26+
### Backend (Desktop)
27+
- **Framework**: Tauri v2 (`@tauri-apps/cli`, `@tauri-apps/api`)
28+
- **Language**: Rust (`src-tauri/src/lib.rs`, `src-tauri/src/main.rs`)
29+
- **Capabilities**: Custom IPC Invoke Commands (`get_opened_files`, `read_file_data`), native OS event handling (`RunEvent::Opened`), and Tauri Webview Drag & Drop events.
30+
31+
---
32+
33+
## 🚀 Key Commands & Workflows
34+
35+
### Prerequisites
36+
- **Node.js** (v20+ recommended)
37+
- **Rust & Cargo** (for Tauri desktop builds)
38+
- **Linux dependencies** (if developing on Linux): `webkit2gtk-4.1`, `gtk3`, `openssl`, `libappindicator-gtk3`
39+
40+
### Development Commands
41+
42+
| Command | Description |
43+
| :--- | :--- |
44+
| `npm run dev` | Starts the Vite frontend development server (web-only mode). |
45+
| `npm run tauri dev` | Starts the full Tauri desktop application development environment. |
46+
| `npm run build` | Builds the React frontend for production into `dist/`. |
47+
| `npm run tauri build` | Builds the native desktop application bundle (`.exe`, `.dmg`, `.deb`/`.AppImage`). |
48+
| `npx tsc --noEmit` | Runs strict TypeScript type-checking across the codebase. |
49+
50+
---
51+
52+
## 🏛️ Implementation Details: File Associations & Drag & Drop
53+
54+
In version `0.1.1_STABLE5`, the interaction between the host Operating System and the Tauri desktop app was overhauled to provide true native desktop integration.
55+
56+
### 1. File Associations & Double-Click Opening
57+
When a user associates `.md` or `.txt` files with MultiMDReader in their OS and double-clicks a file:
58+
- **Windows & Linux**: The OS executes `multimdreader <file_path>`. The Rust backend parses `std::env::args()` via the custom `get_opened_files` Tauri command.
59+
- **macOS / Mobile**: The OS sends an event captured by `tauri::RunEvent::Opened`. The Rust backend stores the incoming URLs in thread-safe managed state (`Mutex<Vec<String>>`) and broadcasts them to the React frontend via the `opened-files` event.
60+
- **Linux Desktop Entry**: The `PKGBUILD` configures `Exec=multimdreader %f` so Linux file managers correctly pass the file path argument.
61+
- **Tauri Bundle**: `tauri.conf.json` includes `fileAssociations` definitions so installers automatically register supported extensions (`.md`, `.markdown`, `.txt`, etc.).
62+
63+
### 2. Native OS Drag & Drop
64+
- **Webview Integration**: Standard HTML5 drag & drop (`onDrop`, `e.dataTransfer.files`) works perfectly in web browsers but is often restricted in secure Webview2/WebKit environments.
65+
- **Tauri Integration**: The desktop app hooks into `getCurrentWebview().onDragDropEvent(...)`. When a native OS drop occurs, Tauri retrieves the file path and passes it to `openTauriPath()`.
66+
67+
### 3. Direct Filesystem Reading (`read_file_data`)
68+
Because webviews cannot use `new FileReader()` on raw desktop file paths (e.g., `C:\path\to\file.md`), the application defines a custom Rust command `read_file_data(path)`. This command securely reads the file contents and retrieves accurate metadata (size, last modified time) directly via Rust's `std::fs`, returning a structured JSON payload to the frontend.
69+
70+
---
71+
72+
## 🖥️ Legacy OS Compatibility (Windows 7 & XP)
73+
74+
To ensure MultiMDReader can run on older hardware and legacy operating systems without internet connectivity or modern TLS protocols:
75+
76+
### Windows 7 Support
77+
- **Embedded Bootstrapper**: In `tauri.conf.json`, `webviewInstallMode` is configured to `embedBootstrapper`. This embeds the Microsoft WebView2 installer directly within the NSIS setup executable. This ensures that on clean Windows 7 installations (where TLS 1.2 is disabled by default and dynamic downloads fail), the runtime is successfully installed offline.
78+
- **Cargo Compatibility**: In Tauri v2, core WebView2 compatibility with Windows 7 is achieved natively without legacy feature flags. (The legacy `windows7-compat` flag is only required if importing the standalone `tauri-plugin-notification` crate).
79+
- **32-bit Architecture**: The repository maintains active x86 (`i686-pc-windows-msvc`) release workflows (`release-windows-x86.yml`) specifically targeting older 32-bit Windows 7 hardware.
80+
81+
### Windows XP Limitations
82+
- **WebView2 / Chromium Requirement**: MultiMDReader (and Tauri v2 in general) **cannot** support Windows XP. Tauri relies on Microsoft WebView2, which is powered by Chromium. Chromium permanently dropped support for Windows XP in 2016 (starting with Chrome 50).
83+
- **Rust Toolchain**: Modern Rust toolchains and Windows API bindings require Windows 7 as the absolute minimum target baseline. For Windows XP, a completely different legacy tech stack (such as Win32 C++ or Electron v1.4) would be required.
84+
85+
---
86+
87+
## 🎨 Code Style & Conventions
88+
89+
1. **Strict TypeScript**: Never use `any`. Explicitly define interfaces (e.g., `RecentFile`, `FileData`). Ensure all React event handlers are correctly typed (`React.ChangeEvent<HTMLInputElement>`, `React.DragEvent`).
90+
2. **Component Structure**: Keep UI components modular. Use functional components with hooks. Memoize functions passed to child components or dependency arrays with `useCallback`.
91+
3. **i18n First**: All user-facing strings must use the `t()` hook from `useTranslation()`. Never hardcode English or Italian strings directly in the JSX. Add new translation keys symmetrically across all JSON files in `src/i18n/locales/`.
92+
4. **Rust Error Handling**: Custom Tauri commands should return `Result<T, String>` rather than panicking (`unwrap()`). Map filesystem errors cleanly so the frontend can display helpful localized error notifications (`t('errors.fileReadError')`).
93+
5. **Tailwind Styling**: Prefer utility classes directly on elements. Use `dark:` variants for all colors to maintain perfect parity between Light and Dark modes.

0 commit comments

Comments
 (0)