How fabianvegaa/qiqe works
Main Components
• Frontend Code Editor: Found under service/auth, this is a React (TypeScript) application that provides the user interface for writing code. It includes pages, components, and supporting libraries (for example, the ace mode integration to support Qiqe syntax).
• Compiler Backend: Located within service/Interpreter, this Haskell service serves as the compiler (likely using gRPC) that translates Qiqe code to JavaScript code. It is structured with modules for lexing, parsing, compiling, evaluating, and tokenizing the input.
• Proxy/Intermediary Service: The service/proxy directory (written in Rust) appears to serve as an additional layer that could be managing requests between the frontend and the compiler backend or handling lower-level operations, possibly related to routing or protocol translation.
• Qiqe Library and Documentation: The qiqe/library and qiqe/doc directories provide the standard language library and documentation with examples. They are essential for understanding the language features and for providing user help.
Relationships and Interactions
• The frontend (code editor) is the entry point where users write Qiqe code.
• The editor submits the code (via HTTP/gRPC calls) to the backend compiler service.
• The compiler processes the code—using its separate modules (Lexer, Parser, Compiler, Evaluator)—and returns compiled JavaScript.
• The proxy component may act as an intermediary to manage or transform the communications between the frontend and the compiler service.
• Documentation and examples support both developers and users by showing language usage and the various example programs.
Important Architectural Patterns and Principles
• Separation of Concerns: The project cleanly breaks down into frontend, backend compilation, and a proxy layer.
• Modular Design: Each major directory (service/auth, service/Interpreter, service/proxy) encapsulates a component’s functionality along with its configuration (using Nix, Cabal, Cargo, etc.) without mixing concerns.
• Clear API/Data Flow: Even though infrastructural deployment details should be minimized, component interactions are geared toward a request (code submission)–response (compiled output) model with clear boundaries.
• Extensibility: With a designated library for the language standard and extensive documentation/examples, the system design shows a clear intent for future expansion (for instance, toward visual programming).