Skip to content

AhmadHassan-BTed/KodeArrow

Repository files navigation

KodeArrow Logo

🏹 KodeArrow

The Next Evolution in Keyboard Navigation

A Masterpiece of Ergonomic Engineering by Ahmad Hassan (B-Ted)

License: MIT Python 3.12+ Architecture: Tiered Mono-Repo Build: Local Engine

🌐 Official Website β€’ πŸ“‚ Key Features β€’ πŸš€ Quick Start


KodeArrow is a production-grade productivity suite designed to revolutionize keyboard ergonomics. It bridges the gap between hardware input and fluid navigation, enabling a seamless "Home Row" experience for power users.

Architecture β€’ Full Suite β€’ Research β€’ Installation


πŸ“– The Vision & Philosophy

"Navigation should be an extension of thought, not a physical strain." β€” Ahmad Hassan (B-Ted)

Navigation inefficiency is often ignored until it causes physical fatigue. KodeArrow was engineered to solve the "Hand Travel" problem. By transforming the home row into a dynamic navigation engine, it allows developers and researchers to maintain absolute focus without breaking their physical workflow. This project represents a shift from human-adapting-to-tools to tools-adapting-to-human-ergonomics.


⌨️ The Ergonomic Suite

KodeArrow provides a complete document control system without leaving the home row.

🧭 Navigation & Editing

Key Mapping Action
Alt + I/J/K/L ⬆️ ⬅️ ⬇️ ➑️ Core Directional Navigation
Alt + U / O Home / End Line Boundaries
Alt + P / ; Del / Backspace Instant Text Deletion
Alt + [ / ' PgUp / PgDn Document Paging

🎨 Visual Mapping Overview

Home Row Mapping Icon
Alt + I Arrow Up
Alt + J Arrow Left
Alt + K Arrow Down
Alt + L Arrow Right

πŸ“Š Edition Comparison

Choose the edition that fits your professional workflow.

Feature Standard Edition Research Edition
Full Ergonomic Suite βœ… Active βœ… Active
Cloud Sync βœ… Active βœ… Active
Telemetry Tracking ❌ None βœ… Real-time
Multi-Device Support Up to 4 1 Dedicated
Research Participation ❌ No βœ… Yes

πŸ”“ Universal Community License

Tip

🌟 Join the Ergonomic Revolution

To support developers, students, and ergonomic enthusiasts worldwide, we have created an open Universal Activation Email that unlocks the complete premium suite of KodeArrow forever!

πŸ“§ Community Key freeforever@kodearrow.dev
Status 🟒 Active & Lifetime
Allowed Devices ♾️ Unlimited Connections
Ergonomic Research Contribution πŸ“Š Active (Anonymous Telemetry Tracking)

✨ Why Use the Community Key?

  • Zero Limits: Bypasses the standard 4-device hardware restriction entirely. Use it across all of your personal and work machines.
  • Contribute to Science: By using this license, your app automatically registers device stats and anonymous telemetry to our database. You are directly contributing data to our ergonomic research and helping shape the future of human-computer interaction!
  • Lifetime Freedom: Never expires. Managed centrally and kept active permanently through the cloud control console.

To Unlock: Simply enter freeforever@kodearrow.dev when prompted during the initial startup activation, and enjoy the ultimate home-row experience.


πŸ§ͺ Scientific Validation

KodeArrow is a scientifically validated ergonomic pattern. Our research lab uses real-time metrics to optimize the navigation workflow.

Accuracy Rate Research Plot
Figure 1: 3D Visualization of user accuracy across the Alt+IJKL navigation field.

βš™οΈ Execution & Compilation

KodeArrow uses a standardized entry point system for both execution and distribution.

Running the Application

Launch specific editions using the --version flag:

  • Standard Edition: python main.py --version standard
  • Research Edition: python main.py --version r_edition

Compiling to Executable

The production build pipeline is fully automated. To generate a standalone .exe:

python infrastructure/build/build.py

Generated binaries will be located in the dist/ directory.

Running the Test Suite

Verify architectural and logical integrity before deployment:

python -m pytest

πŸš€ Getting Started

New people are welcomed to participate in development.

Prerequisites

  • Python 3.12 or higher
  • Windows 10/11 (Preferred for Win32-hook stability)

Installation

  1. Clone & Enter:
    git clone https://github.com/AhmadHassan-BTed/KodeArrow.git
  2. Environment Setup:
    pip install -r config/requirements.txt
  3. Configuration:
    • Duplicate config/.env.example and rename it to config/.env.
    • Open config/.env and fill in your Firebase credentials and License keys.
  4. Execution:
    python main.py --version standard

πŸ› οΈ Build & Deployment Flow

The project utilizes a high-performance local build engine to ensure consistent, secure binaries for end-users.

%%{init: {'flowchart': {'curve': 'stepBefore'}}}%%
graph LR
    S[Source Code] --> B[infrastructure/build/build.py]
    B --> A[Asset Bundling]
    A --> P[PyInstaller Engine]
    P --> EXE[dist/KodeArrow.exe]
    style EXE fill:#f9f,stroke:#333,stroke-width:4px
Loading

Deployment: The official web presence is managed and deployed independently at ahmadhassan-bted.github.io/KodeArrow.


πŸ—οΈ Architecture Overview

The system follows a Tiered Mono-Repo structure, ensuring zero coupling between the product core and research utilities.

%%{init: {'flowchart': {'curve': 'stepBefore'}}}%%
graph TD
    Root[Project Root] --> Core[core/ - Product Engine]
    Root --> Packages[packages/tools/ - Utilities]
    Root --> Infra[infrastructure/ - Build & CI]
    Root --> Assets[assets/ - Global Identity]

    subgraph "Core Package Architecture"
        Common[common/ - Shared Logic] --> Services[services/ - Firebase & Sub]
        Common --> GUI[gui/ - CTk Windows]
        Common --> Utils[utils/ - Encryption & Helpers]
        Versions[versions/ - Editions] --> Standard[standard/ - App]
        Versions --> REdition[r_edition/ - Telemetry]
    end
Loading

πŸ”„ Request Lifecycle

How a single hotkey press travels through the layers of KodeArrow.

sequenceDiagram
    participant U as User
    participant H as Keyboard Hook (Low-Level)
    participant V as Validation Layer
    participant E as Execution Engine (PyAutoGUI)
    participant C as Cloud Telemetry

    U->>H: Press Alt + Hotkey Suite
    H->>V: Capture Event & Suppress
    V->>V: Check Hardware ID & License
    alt Authorized
        V->>E: Dispatch Virtual Key Signal
        E->>U: OS-Level Action (Nav/Edit)
        V->>C: Batch Research Data (R-Edition)
    else Unauthorized
        V->>U: Trigger CTk Padlock Window
    end
Loading

Engineered by Ahmad Hassan (B-Ted) Redefining Human-Computer Interaction

Official Website β€’ GitHub β€’ Portfolio β€’ LinkedIn

About

An ergonomic Windows utility that maps arrow and navigation keys directly to the home row. Boost typing speed and stay in the flow by using Alt combinations to navigate, delete, and jump lines without ever lifting your hands.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors