Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
</div>

# CircuitVerse Frontend Vue
[CircuitVerse Frontend Vue](https://circuitverse.netlify.app/simulatorvue) is dedicated to enhancing the CircuitVerse platform in several key ways. Our primary focus is on decoupling the [CircuitVerse Simulator](https://circuitverse.org/simulator) from the backend, allowing it to function independently and with greater flexibility. Additionally, we're working to remove the reliance on jQueryUI, opting for cleaner and more contemporary code practices. To improve performance and code readability, we're transitioning from traditional DOM mutations to string-based manipulation. Furthermore, we're actively integrating internationalization features to ensure the platform is accessible to users worldwide. In summary, our repository aims to elevate the capabilities and user experience of CircuitVerse through targeted improvements and optimizations.
[CircuitVerse Frontend Vue](https://circuitverse.netlify.app/simulatorvue) is dedicated to enhancing the CircuitVerse platform in several key ways. Our primary focus is on decoupling the [CircuitVerse Simulator](https://circuitverse.org/simulator) from the backend, allowing it to function independently and with greater flexibility. Additionally, we're working to remove the reliance on jQueryUI, opting for
cleaner and more contemporary code practices. To improve performance and code readability, we're transitioning from traditional DOM mutations to string-based manipulation. Furthermore, we're actively integrating internationalization features to ensure the platform is accessible to users worldwide. In summary, our repository aims to elevate the capabilities and user experience of CircuitVerse through targeted improvements and optimizations.

## Community
We would love to hear from you! We communicate on Slack:
Expand Down Expand Up @@ -55,6 +56,7 @@ To build a specific version:
npm run build -- v1
```


### Custom Mounting Point (e.g. for Rails)
If you mount the simulator on a different path than the default `/simulatorvue/`, you must specify the `VITE_BASE` environment variable during build:

Expand All @@ -67,6 +69,41 @@ Built assets will be available in `dist/simulatorvue/`. Each version will have a
- `dist/simulatorvue/v0/simulator-v0.js`
- `dist/simulatorvue/v1/simulator-v1.js`

## Desktop (Tauri) — Prerequisites & running

This repository includes a Tauri-based desktop application wrapper. To run or build the desktop app you need a working Node.js environment and the Rust toolchain.

Prerequisites (minimum):

- Node.js (recommended: 20+ / Active LTS)
- npm (comes with Node.js)
- Rust toolchain (stable) with `cargo` (https://www.rust-lang.org/tools/install)
- On macOS: Xcode Command Line Tools (install via `xcode-select --install`) and a working C toolchain
Comment thread
coderabbitai[bot] marked this conversation as resolved.
- On Linux: system dependencies such as `libwebkit2gtk-4.1-dev`, `build-essential`, `libssl-dev` (package names vary by distro)
- On Windows: Microsoft Visual C++ Build Tools (MSVC) and Microsoft Edge WebView2

Install JavaScript dependencies first:

```bash
npm install
```

Run the Tauri development desktop app (hot reload):

```bash
npm run tauri dev
```

Build a production desktop bundle:

```bash
npm run tauri build
```

Note: If you haven't installed the Tauri CLI or other native prerequisites, follow the official Tauri setup docs for your platform: https://v2.tauri.app/start/prerequisites/



## Route-Agnostic Support
The simulator is designed to be **route-agnostic**. It can be mounted on any path (e.g., within a Rails view) by including the appropriate script and setting global variables:

Expand Down
Loading