How ethereum/remix-project works
Project Type and Purpose
• This is a large Nx-powered monorepo (“remix-project”) for Ethereum smart-contract development.
• It bundles multiple React/TypeScript applications (apps/) and shared libraries (libs/) into a plugin-based IDE toolset:
• Remix Online IDE (web, browser)
• Remix Desktop IDE (Electron)
• Auxiliary front-ends (circuit-compiler, contract-verification, debugger, doc-gen, doc-viewer, quick-dapp, learneth, solhint, solidity-compiler, vyper, etc.)
• CLI tools and services (remixd file server, remix-tests, remix-debug CLI)
• E2E test harness (Nightwatch + WebDriver)
High-Level File Structure
• /apps – all end-user applications, each with its own React+Webpack setup
• /libs – shared modules (core engine, UI components, plugin API definitions, compilers, simulators, analyzers)
• CI & tooling – .circleci, GitHub workflows, Dockerfiles, nx.json, tsconfig.*, lerna.json
• Root scripts – build, serve, docker-compose, release management
Key Architectural Patterns
• Monorepo with Nx for task orchestration, dependency graph, builds and tests
• Plugin-based architecture: a “host” (IDE) loads independent plugins via a standardized plugin API (remix-api + remix-core-plugin)
• Shared services in libs: execution engine (remix-lib), compilers (remix-solidity, solc, vyper), static analysis (remix-analyzer), blockchain simulator (remix-simulator), debugger (remix-debug)
• Frontends use React + Redux and remix-ui component library; communicate with core and plugins via contexts and service clients
Main Components
• Monorepo & Build System
• Nx CLI / Yarn (or Lerna)
• CI/CD pipelines (CircleCI, GitHub Actions, Docker)
• Shared Libraries (libs/)
• Core engine (remix-lib)
• Plugin API (remix-api)
• Core plugin logic (remix-core-plugin)
• UI component library (remix-ui)
• Compiler wrappers (remix-solidity, solidity-compiler, vyper)
• Simulator and debugger (remix-simulator, remix-debug)
• Analyzer (remix-analyzer)
• Applications (apps/)
• Browser IDE (apps/remix-ide)
• Desktop IDE (apps/remixdesktop – Electron main + preload + plugins)
• Other plugin‐demo frontends (e.g., circuit-compiler, contract-verification, debugger UI)
• File-server daemon (apps/remixd)
• E2E Test Runner (apps/remix-ide-e2e)
• External Services
• Ethereum JSON-RPC endpoints (Infura, Alchemy, Ganache, Hardhat node)
• IPFS / Swarm (publish-to-storage plugin)
• GitHub / dGit for file storage
• Inference server (for AI plugin)
Relationships & Data Flows
• Developer or user ↔ Browser IDE ↔ Plugin Engine ↔ Plugins ↔ Core Libraries ↔ External Services
• Desktop IDE wraps the same browser IDE + Electron IPC to local file system / native executables (circom, hardhat)
• remixd runs a local WebSocket service to expose file system to the browser IDE
• CI/CD builds libraries → bundles → publishes Docker images / web artifacts / desktop releases
• E2E harness drives the Browser IDE via WebDriver, tests across hosted builds or local serve
Essential Elements
• A title and version footer (“Remix Project Architecture v1.0”, date)