Syntaxed Desktop

(Needs Update)

Professional Code Typing Trainer - Native Desktop Edition

A high-performance desktop application built with Tauri + Rust that transforms the acclaimed Syntaxed web application into a native desktop experience.

---

✨ Features

🚀 Native Desktop Performance

• 15MB bundle size (10x smaller than Electron alternatives)
• Native webview rendering for optimal performance
• 60fps real-time metrics with Rust-powered backend
• Instant startup with no browser overhead

🎯 Complete Typing Trainer

• 25+ programming languages supported
• Monaco Editor integration with full syntax highlighting
• Real-time WPM, accuracy, and error tracking
• Comprehensive statistics system with persistent storage
• Personal best tracking for each language and topic

🖥️ Desktop-First Experience

• Native window management with proper minimize/maximize
• System taskbar integration
• Desktop-optimized UI (1200x800 default, 800x600 minimum)
• No internet required - fully offline capable
• Cross-platform support (Windows, macOS, Linux)

🎨 Modern Interface

• Dark/Light theme toggle with system preference detection
• Fully responsive design adapted for desktop use
• Professional Monaco Editor (VS Code engine)
• Clean, distraction-free typing environment

---

🛠️ Tech Stack

Architecture:

• Frontend: Vanilla HTML/CSS/JavaScript with Monaco Editor
• Backend: Rust with Tauri framework
• Bundling: Native system webview (no Chromium overhead)
• Build System: Cargo + npm integration

---

📦 Installation

Prerequisites

• Rust (latest stable) - Install Rust
• Node.js (v16+) - Install Node.js
• Git - Install Git

Development Setup

# Clone the repository
git clone https://github.com/burkifa23/syntaxed-desktop.git
cd syntaxed-desktop

# Install Node.js dependencies
npm install

# Run in development mode (hot reload)
npm run tauri:dev

# Build for production
npm run tauri:build

First Run

The first npm run tauri:dev will:

1. Download Rust dependencies (2-3 minutes)
2. Compile Tauri backend (3-5 minutes)
3. Open desktop application automatically

Subsequent runs are much faster (~10-30 seconds).

---

🎮 Usage

Quick Start

1. Launch the application
2. Select programming language from dropdown (25+ available)
3. Choose topic: Start, Variables, Control Flow, or Functions
4. Begin typing when you see the code snippet
5. Track progress with real-time metrics
6. View statistics to monitor improvement

Keyboard Shortcuts

• Alt + Q - Stop current test
• Alt + R - Reset test
• Alt + B - Enable dark mode
• Alt + W - Enable light mode
• Alt + S - View statistics

Supported Languages

Systems Programming: C, C++, Rust, Go, Zig
Web Development: JavaScript, TypeScript, HTML, CSS, PHP
Data Science: Python, R, Julia
Enterprise: Java, C#, Scala, Kotlin
Functional: Haskell, Clojure, Elixir, Erlang
Scripting: Bash, Lua
Mobile: Swift, Dart
Legacy: COBOL, Fortran

---

🏗️ Development

Project Structure

syntaxed-desktop/
├── src-tauri/              # Rust backend
│   ├── src/
│   │   ├── main.rs         # Application entry point
│   │   └── lib.rs          # Core Rust logic
│   ├── Cargo.toml          # Rust dependencies
│   └── tauri.conf.json     # Tauri configuration
├── index.html              # Frontend entry point
├── styles.css              # Application styles  
├── script.js               # Core application logic
├── snippets/               # Code snippet library
└── package.json            # Node.js configuration

Available Scripts

npm run tauri:dev       # Development with hot reload
npm run tauri:build     # Production build
npm run tauri           # Direct Tauri CLI access

Building for Distribution

# Build optimized bundles for current platform
npm run tauri:build

# Output locations:
# Windows: src-tauri/target/release/bundle/msi/
# macOS:   src-tauri/target/release/bundle/dmg/
# Linux:   src-tauri/target/release/bundle/deb/

---

🚀 Performance

Bundle Size Comparison

Framework	Bundle Size	Startup Time	Memory Usage
Syntaxed Desktop (Tauri)	~15MB	< 1s	~50MB
Electron Alternative	~150MB	~3s	~200MB
Native Web App	~5MB	~0.5s	~30MB

Why Tauri?

• ✅ 90% smaller than Electron-based alternatives
• ✅ Native performance with system webview
• ✅ Memory efficient - no bundled Chromium
• ✅ Security focused - Rust memory safety
• ✅ Cross-platform - single codebase

---

🔧 Configuration

Window Settings

Edit src-tauri/tauri.conf.json to customize:

{
  "app": {
    "windows": [{
      "title": "Syntaxed - Professional Code Typing Trainer",
      "width": 1200,
      "height": 800,
      "minWidth": 800,
      "minHeight": 600,
      "resizable": true
    }]
  }
}

Adding New Languages

1. Create snippet files in snippets/[language]/
2. Update language list in script.js
3. Test with npm run tauri:dev

---

🤝 Contributing

We welcome contributions! Whether you're:

• 🐛 Reporting bugs or requesting features
• 🦀 Adding Rust backend features
• 🌐 Improving the web frontend
• 📝 Enhancing documentation
• 🎨 Designing better UX

Development Workflow

1. Fork the repository
2. Create feature branch (git checkout -b feature/amazing-feature)
3. Test thoroughly with npm run tauri:dev
4. Commit changes (git commit -m 'Add amazing feature')
5. Push to branch (git push origin feature/amazing-feature)
6. Open Pull Request

---

📊 Roadmap

v1.1 - Desktop Polish

• Custom application icons
• System tray integration
• Auto-updater functionality
• Installer improvements

v1.2 - Rust Features

• Native notification system
• File system statistics storage
• Performance optimizations
• Native file dialogs

v2.0 - Advanced Features

• Multiplayer typing competitions
• Advanced analytics dashboard
• Plugin system for custom languages
• AI-powered difficulty adjustment

---

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🙏 Acknowledgments

• Tauri Team - For the incredible native app framework
• Monaco Editor - VS Code's excellent editor
• Original Syntaxed - The foundational web application
• Rust Community - For the amazing language and ecosystem

---

🔗 Related Projects

• 🌐 Syntaxed Web - Original browser-based version
• 🚀 Live Demo - Try it in your browser
• 📱 Syntaxed Mobile - Coming soon!

---

Built with ❤️ by Burkifa23 & Programmer-233

Powered by 🦀 Rust + ⚡ Tauri

⭐ Star us if you find this useful!