CircuitVerse / cv-frontend-vue

https://circuitverse.netlify.app/
MIT License
29 stars 102 forks source link

feat: Desktop Application for Vue Simulator [Tauri] #374

Closed niladrix719 closed 1 month ago

niladrix719 commented 2 months ago

Desktop Application for Vue Simulator using Tauri

https://github.com/user-attachments/assets/8a9d0c08-e434-4bea-83f4-a32deec01659

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes encompass updates to several configuration files and components within the project. Key modifications include the introduction of Tauri support, adjustments to build commands, and enhancements to file handling methods. The .gitignore files have been updated to exclude unnecessary directories, while the package.json file reflects new dependencies and scripts. Additionally, various components have been refactored to improve file download functionality and state management, alongside the addition of event listeners for enhanced interactivity.

Changes

File(s) Change Summary
.gitignore, src-tauri/.gitignore Added entries to ignore generated files and directories, preventing unnecessary tracking by Git.
netlify.toml, vite.config.ts Modified build commands and output paths, including changes to directory structures and environment variables.
package.json Updated scripts to include cross-env for environment variable management and added Tauri-related dependencies.
src-tauri/Cargo.toml, src-tauri/build.rs, src-tauri/src/main.rs, src-tauri/tauri.conf.json Introduced files and configurations for Tauri application setup, including metadata and build dependencies.
src/components/DialogBox/*.vue Changed file download methods to use downloadFile instead of download, aligning with new naming conventions.
src/components/DialogBox/OpenOffline.vue Updated state management for projectList from reactive to ref.
src/simulator/src/data/project.ts Simplified data storage logic in saveOffline by removing JSON serialization.
src/simulator/src/node.js Adjusted type check in saveObject method for node classification.
src/simulator/src/plotArea.js Enhanced image downloading functionality with checks for Tauri environment.
src/simulator/src/utils.ts Introduced new download functions for desktop and web environments, improving modularity.
src/simulator/src/listeners.js Added multiple event listeners to handle various user actions, enhancing interactivity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Tauri
    participant Server

    User->>App: Initiate file download
    App->>App: Determine environment (Tauri or Web)
    alt Tauri
        App->>Tauri: Call downloadImageDesktop()
        Tauri->>Tauri: Fetch image data
        Tauri->>User: Save image to downloads directory
    else Web
        App->>App: Call downloadFileWeb()
        App->>User: Trigger browser download
    end

🐰 In the meadow where I hop and play,
New changes come to brighten the day!
With Tauri's magic, files now glide,
A smoother path for all to ride.
Let’s download joy, in leaps and bounds,
In this happy code, my heart resounds! 🌼✨


Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between a6b0db328e461dd04f09206fd28d9e8757249e4a and aea924a1088a449727861ea0a2bd089d4f0665de.
Files selected for processing (1) * src/simulator/src/listeners.js (3 hunks)
Files skipped from review as they are similar to previous changes (1) * src/simulator/src/listeners.js
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: -- `@coderabbitai generate unit testing code for this file.` -- `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
netlify[bot] commented 2 months ago

Deploy Preview for circuitverse ready!

Name Link
Latest commit aea924a1088a449727861ea0a2bd089d4f0665de
Latest deploy log https://app.netlify.com/sites/circuitverse/deploys/66ec386128af7b00083eed62
Deploy Preview https://deploy-preview-374--circuitverse.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

tachyons commented 2 months ago

could you explore adding native menu?

https://tauri.app/v1/guides/features/menu/

tachyons commented 2 months ago

You can also add github action for release https://github.com/tauri-apps/tauri-action

tachyons commented 1 month ago

@niladrix719 Could you fix the git conflict ?